歡迎您光臨本站 註冊首頁

BeetlSQL 3.0.0-M1 第一個版本釋出

←手機掃碼閱讀     admin @ 2020-08-14 , reply:0

經過8個月的重構,BeetlSQL3里程碑1已經完成

BeetlSQL是一款資料庫訪問工具庫,廣泛應用到企業應用,網際網路專案。相比於BeetlSQL2,新版支援更多資料來源,包括支援JDBC的傳統資料庫,大資料NOSQL,以及大資料SQL查詢引擎,在易用性何擴充套件性也做了大幅度修改。BeetlSQL3 能最大程度提高開發資料庫訪問的效率和增強相關程式碼維護性

BeetlSQL解決了很多資料庫訪問工具的不足

  • 開發效率低,如mybatis,還需要搭配plus工具才能提高開發效率,而JOOQ這樣的又不適合複雜訪問
  • 無SQL管理,遇到複雜的sql特別難維護,比如在Java裡拼寫sql,遇到調整就麻煩
  • 跨資料庫平臺,即使Hibenerate,也完全做不到跨資料庫
  • 缺少資料庫和NOSQL無縫切換很難,比如一部分業務要無縫切換到NOSQL上
  • 資料庫重構對程式碼影響非常大,資料庫列修改,增加要改很多程式碼
  • 難以除錯資料庫訪問程式碼,比如JOOQ

Maven


 <dependency>
   <groupId>com.ibeetl</groupId>
   <artifactId>beetlsql-all</artifactId>
   <version>3.0.0-M1</version>
 </dependency>
 

例子1,內建方法,無需寫SQL完成常用操作


 UserEntity user  = sqlManager.unique(UserEntity.class,1);
 
 user.setName("ok123");
 sqlManager.updateById(user);
 
 UserEntity newUser = new UserEntity();
 newUser.setName("newUser");
 newUser.setDepartmentId(1);
 sqlManager.insert(newUser);
 
 

輸出日誌友好,可反向定位到呼叫的程式碼


 ┏━━━━━ Debug [user.selectUserAndDepartment] ━━━
 ┣ SQL:     select * from user where 1 = 1 and id=?
 ┣ 引數:     [1]
 ┣ 位置:     org.beetl.sql.test.QuickTest.main(QuickTest.java:47)
 ┣ 時間:     23ms
 ┣ 結果:     [1]
 ┗━━━━━ Debug [user.selectUserAndDepartment] ━━━
 

例子2 使用SQL


 String sql = "select * from user where id=?";
 Integer id  = 1;
 SQLReady sqlReady = new SQLReady(sql,new Object[id]);
 List<UserEntity> userEntities = sqlManager.execute(sqlReady,UserEntity.class);
 //Map 也可以作為輸入輸出引數
 List<Map> listMap =  sqlManager.execute(sqlReady,Map.class);
 

例子3 使用模板SQL


 String sql = "select * from user where department_id=#{id} and name=#{name}";
 UserEntity paras = new UserEntity();
 paras.setDepartmentId(1);
 paras.setName("lijz");
 List<UserEntity> list = sqlManager.execute(sql,UserEntity.class,paras);
 
 String sql = "select * from user where id in ( #{join(ids)} )";
 List list = Arrays.asList(1,2,3,4,5); Map paras = new HashMap();
 paras.put("ids", list);
 List<UserEntity> users = sqlManager.execute(sql, UserEntity.class, paras);
 

例子4 使用Query類

支援重構


 LambdaQuery<UserEntity> query = sqlManager.lambdaQuery(UserEntity.class);
 List<UserEntity> entities = query.andEq(UserEntity::getDepartmentId,1)
                     .andIsNotNull(UserEntity::getName).select();
 
 

例子5 把數十行SQL放到sql檔案裡維護


 //訪問user.md#select
 SqlId id = SqlId.of("user","select");
 Map map = new HashMap();
 map.put("name","n");
 List<UserEntity> list = sqlManager.select(id,UserEntity.class,map);
 

例子6 複雜對映支援

支援像mybatis那樣複雜的對映

  • 自動對映

 @Data
 @ResultProvider(AutoJsonMapper.class)
  public static class MyUserView {
         UserInfo user;
         DepartmentEntity dept;
  }
 
 
  • 配置對映,比MyBatis更容易理解,報錯資訊更詳細

 {
 	"id": "id",
 	"name": "name",
 	"dept": {
 		"id": "dept_id",
 		"name": "dept_name"
 	},
 	"roles": {
 		"id": "r_id",
 		"name": "r_name"
 	}
 }
 

例子7 最佳實踐,使用mapper來作為資料庫訪問類


 @SqlResource("user") /*sql檔案在user.md裡*/
 public interface UserMapper extends BaseMapper<UserEntity> {
 
     @Sql("select * from user where id = ?")
     UserEntity queryUserById(Integer id);
 
     @Sql("update user set name=? where id = ?")
     @Update
     int updateName(String name,Integer id);
 
     @Template("select * from user where id = #{id}")
     UserEntity getUserById(Integer id);
 
     @SpringData/*Spring Data風格*/
     List<UserEntity> queryByNameOrderById(String name);
 
     /**
      * 可以定義一個default介面
      * @return
      */
      default  List<DepartmentEntity> findAllDepartment(){
         Map paras = new HashMap();
         paras.put("exlcudeId",1);
         List<DepartmentEntity> list = getSQLManager().execute("select * from department where id != #{exlcudeId}",DepartmentEntity.class,paras);
         return list;
     }
 
 
     /**
      * 呼叫sql檔案user.md#select,方法名即markdown片段名字
      * @param name
      * @return
      */
      List<UserEntity> select(String name);
 
 
     /**
      * 翻頁查詢,呼叫user.md#pageQuery
      * @param deptId
      * @param pageRequest
      * @return
      */
     PageResult<UserEntity>  pageQuery(Integer deptId, PageRequest pageRequest);
 	
     @SqlProvider(provider= S01MapperSelectSample.SelectUserProvider.class)
     List<UserEntity> queryUserByCondition(String name);
 
     @SqlTemplateProvider(provider= S01MapperSelectSample.SelectUs
     List<UserEntity> queryUserByTemplateCondition(String name);
 }
 

你看到的這些用在Mapper上註解都是可以自定義,自己擴充套件的

例子8 使用Fetch 註解

可以在查詢後根據Fetch註解再次獲取相關物件,實際上@FetchOne和 @FetchMany是自定義的,使用者可自行擴充套件


     @Data
     @Table(name="user")
     @Fetch
     public static class UserData {
         @Auto
         private Integer id;
         private String name;
         private Integer departmentId;
         @FetchOne("departmentId")
         private DepartmentData dept;
     }
 
     /**
      * 部門資料使用"b" sqlmanager
      */
     @Data
     @Table(name="department")
     @Fetch
     public static class DepartmentData {
         @Auto
         private Integer id;
         private String name;
         @FetchMany("departmentId")
         private List<UserData> users;
     }
 
 

例子9 不同資料庫切換

可以自行擴充套件ConditionalSQLManager的decide方法,來決定使用哪個SQLManager


         SQLManager a = SampleHelper.init();
         SQLManager b = SampleHelper.init();
         Map<String, SQLManager> map = new HashMap<>();
         map.put("a", a);
         map.put("b", b);
         SQLManager sqlManager = new ConditionalSQLManager(a, map);
 
         //不同物件,用不同sqlManager操作,存入不同的資料庫
         UserData user = new UserData();
         user.setName("hello");
         user.setDepartmentId(2);
         sqlManager.insert(user);
 
         DepartmentData dept = new DepartmentData();
         dept.setName("dept");
         sqlManager.insert(dept);
 
 

使用註解 @TargetSQLManager來決定使用哪個SQLManger


     @Data
     @Table(name = "department")
     @TargetSQLManager("b")
     public static class DepartmentData {
         @Auto
         private Integer id;
         private String name;
     }
 

例子10 如果想給每個sql語句增加一個sqlId標識

這樣好處是方便資料庫DBA與程式設計師溝通,免得雞同鴨講


  public static class SqlIdAppendInterceptor implements  Interceptor{
         @Override
         public void before(InterceptorContext ctx) {
             ExecuteContext context = ctx.getExecuteContext();
             String jdbcSql = context.sqlResult.jdbcSql;
             String info  = context.sqlId.toString();
             //為傳送到資料庫的sql增加一個註釋說明,方便資料庫dba能與開發人員溝通
             jdbcSql = "/*"+info+"*/\n"+jdbcSql;
             context.sqlResult.jdbcSql = jdbcSql;
         }
  }
 

例子11 程式碼生成框架

可以使用內建的程式碼生成框架生成程式碼何文件,也可以自定義的,使用者可自行擴充套件SourceBuilder類


 	List<SourceBuilder> sourceBuilder = new ArrayList<>();
 	SourceBuilder entityBuilder = new EntitySourceBuilder();
 	SourceBuilder mapperBuilder = new MapperSourceBuilder();
 	SourceBuilder mdBuilder = new MDSourceBuilder();
 	//資料庫markdown文件
 	SourceBuilder docBuilder = new MDDocBuilder();
 
 	sourceBuilder.add(entityBuilder);
 	sourceBuilder.add(mapperBuilder);
 	sourceBuilder.add(mdBuilder);
 	sourceBuilder.add(docBuilder);
     SourceConfig config = new SourceConfig(sqlManager,sourceBuilder);
    //只輸出到控制檯
 	ConsoleOnlyProject project = new ConsoleOnlyProject();
 	String tableName = "USER";
 	config.gen(tableName,project);
 

例子13 定義一個Beetl函式


         GroupTemplate groupTemplate = groupTemplate();
         groupTemplate.registerFunction("nextDay",new NextDayFunction());
 
         Map map = new HashMap();
         map.put("date",new Date());
         String sql = "select * from user where create_time is not null and create_time<#{nextDay(date)}";
         List<UserEntity> count = sqlManager.execute(sql,UserEntity.class,map);
 

nextDay函式是一個Beetl函式,非常容易定義,非常容易在sql模板語句裡使用


    public static class NextDayFunction implements Function {
 
         @Override
         public Object call(Object[] paras, Context ctx) {
             Date date = (Date) paras[0];
             Calendar c = Calendar.getInstance();
             c.setTime(date);
             c.add(Calendar.DAY_OF_YEAR, 1); // 今天+1天
             return c.getTime();
         }
     }
 

例子14 更多可擴充套件的例子

根據ID或者上下文自動分表,toTable是定義的一個Beetl函式,


     static final String USER_TABLE="${toTable('user',id)}";
     @Data
     @Table(name = USER_TABLE)
     public static class MyUser {
         @AssignID
         private Integer id;
         private String name;
     }
 

定義一個Jackson註解,@Builder是註解的註解,表示用Builder指示的類來解釋執行,可以看到BeetlSQL的註解可擴充套件性就是來源於@Build註解


 @Retention(RetentionPolicy.RUNTIME)
 @Target(value = {ElementType.METHOD, ElementType.FIELD})
 @Builder(JacksonConvert.class)
 public @interface Jackson {
 
 }
 

定義一個@Tenant 放在POJO上,BeetlSQL執行時候會給SQL新增額外引數,這裡同樣使用了@Build註解


 
 /**
  * 組合註解,給相關操作新增額外的租戶資訊,從而實現根據租戶分表或者分庫
  */
 @Retention(RetentionPolicy.RUNTIM@
 @Target(value = {ElementType.TYPE})
 @Builder(TenantContext.class)
 public @interface Tenant {
 
 }
 

使用XML而不是JSON作為對映


 @Retention(RetentionPolicy.RUNTIME)
 @Target(value = {ElementType.TYPE})
 @Builder(ProviderConfig.class)
 public @interface XmlMapping {
     String path() default "";
 }
 
 

參考原始碼例子 PluginAnnotationSample瞭解如何定義自定的註解,實際上BeetlSQL有一半的註解都是透過核心註解擴展出來的

BeetlSQL的架構如下,歡迎參與到BeetlSQL3的生態開發 


[admin ]

來源:OsChina
連結:https://www.oschina.net/news/117899/beetl-3-0-0-m1-released
BeetlSQL 3.0.0-M1 第一個版本釋出已經有113次圍觀

http://coctec.com/news/all/show-post-248805.html