https://github.com/yuanwenqing/protobuf4j

A Facility Framework to Develop with Google Protobuf
https://github.com/yuanwenqing/protobuf4j

dao framework orm protobuf protobuf3 spring-boot sql

Last synced: about 1 month ago
JSON representation

A Facility Framework to Develop with Google Protobuf

• Host: GitHub
• URL: https://github.com/yuanwenqing/protobuf4j
• Owner: YuanWenqing
• License: apache-2.0
• Created: 2018-06-26T11:02:40.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-09-19T09:56:54.000Z (over 4 years ago)
• Last Synced: 2024-11-15T06:06:14.566Z (2 months ago)
• Topics: dao, framework, orm, protobuf, protobuf3, spring-boot, sql
• Language: Java
• Homepage:
• Size: 611 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Protobuf4j

## Introduction

A Facility framework to develop with Google Protobuf, including:

* Utils to handle Protobuf messages and enums

* ORM-based DAO for storing Protobuf Message in MySQL

* Some supports with Spring and SpringBoot

## Modules

* `protobuf4j-core`: helper class for Protobuf Message and Enum, codec class for Message.

* `protobuf4j-sql`: abstraction for SQL fragment and statement.

* `protobuf4j-orm`: basic ORM-like DAO framework utilizing `protobuf4j-sql`

* `protobuf4j-orm-starter`: springboot starter for `protobuf4j-orm`, including autoconfiguration and jdbc injection

* `protobuf4j-spring`: some extensions for Protobuf to integrate with spring

## ORM Usage

### Gradle

~~~groovy

implementation("xyz.codemeans.protobuf4j:protobuf4j-orm-starter:$protobuf4jVersion")

~~~

The latest version can be found in maven central repository.

### Properties

~~~properties

protobuf4j.datasource.auto-enable=

~~~

### Java

Example Code: [example](example/src/main)

interface

~~~java

public interface ExampleDao extends IPrimaryKeyMessageDao {

}

~~~

impl

~~~java

@Repository

public class ExampleDaoImpl extends PrimaryKeyProtoMessageDao implements ExampleDao {

  public ExampleDaoImpl() {

    super(Example.class, ExampleNaming.ID);

  }

}

~~~

### CRUD

~~~java

@Autowired

ExampleDao exampleDao;

public Example createExample(Example example) {

  long id = exampleDao.insertReturnKey(example).longValue();

  return exampleDao.selectOneByPrimaryKey(id);

}

public Example getExample(long id) {

  return exampleDao.selectOneByPrimaryKey(id);

  // or

  //return exampleDao.selectOneByCond(FieldAndValue.eq(ExampleNaming.ID, id));

}

public Example updateExample(Example newValue, Example oldValue) {

  exampleDao.updateMessageByPrimaryKey(newValue, oldValue);

  return exampleDao.selectOneByPrimaryKey(newValue.getId());

}

public void deleteExample(long id) {

  exampleDao.deleteByPrimaryKey(id);

}

// complex conditions and pagination

public List listExamples(WhereClause where) {

  return exampleDao.selectByWhere(where);

}

public Map getExamples(Collection ids) {

  return exampleDao.selectMultiByPrimaryKey(ids);

}

~~~

## SQL Usage

~~~java

// condition

List conds = Lists.newArrayList();

conds.add(FieldAndValue.like(ExampleNaming.NAME, SqlUtil.likePrefix(prefix)));

conds.add(FieldAndValue.gte(ExampleNaming.ID, beg));

conds.add(FieldAndValue.lt(ExampleNaming.ID, end));

IExpression allAndCond = LogicalExpr.and(conds));

// pagination

PaginationClause.newBuilder(limit).buildByOffset(offset);

PaginationClause.newBuilder(limit).buildByPageNo(pn)

// select specified columns

SelectClause selectClause = new SelectClause();

selectClause.select(ExampleNaming.NAME);

FromClause fromClause = QueryCreator.fromType(Example.class);

SelectSql sql = new SelectSql(selectClause, fromClause);

exampleDao.doSelect(sql, new SingleColumnRowMapper<>(String.class));

// update whole message with different fields

exampleDao.updateMessageByPrimaryKey(newValue, oldValue);

~~~

## Reference

* `naming`: a Protobuf codegen plugin to generate *Naming class containing field naming constatns, see