《开源精选》是我们分享 Github、Gitee 等开源社区中优质项目的栏目，包括技术、学习、实用与各种有趣的内容。本期推荐的是一个开发高效，维护高效，运行高效的数据库访问框架。

BeetlSQL 的目标是提供开发高效，维护高效，运行高效的数据库访问框架，在一个系统多个库的情况下，提供一致的编写代码方式。支持如下数据平台：

BeetlSQL 不仅仅是简单的类似Mybatis或者是Hibernate，或者是俩着的综合，BeetlSQL 远大理想是对标甚至超越spring Data，是实现数据访问统一的框架，无论是传统数据库，还是大数据，还是查询引擎或者时序库，内存数据库。

BeetlSQL 的架构

除了 SQLManager 和 ClassAnnotations，任何一部分都可以扩展

BeetlSQL 依赖

    com.ibeetl
    beetlsql
    3.${version}

    com.ibeetl
    beetlsql
    2.13.3.RELEASE

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 userEntities = sqlManager.execute(sqlReady,UserEntity.class);
//Map 也可以作为输入输出参数
List

例子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 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 users = sqlManager.execute(sql, UserEntity.class, paras);

例子4 使用 Query 类

支持重构

LambdaQuery query = sqlManager.lambdaQuery(UserEntity.class);
List 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 list = sqlManager.select(id,UserEntity.class,map);

例子6 复杂映射支持

支持像 mybatis 那样复杂的映射

@Data
@ResultProvider(AutoJsonMapper.class)
 public static class MyUserView {
        Integer id;
        String name;
        DepartmentEntity dept;
 }

{
   "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 {

    @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 queryByNameOrderById(String name);

    /**
     * 可以定义一个default接口
     * @return
     */
     default  List findAllDepartment(){
        Map paras = new HashMap();
        paras.put("exlcudeId",1);
        List list = getSQLManager().execute("select * from department where id != #{exlcudeId}",DepartmentEntity.class,paras);
        return list;
    }


    /**
     * 调用sql文件user.md#select,方法名即markdown片段名字
     * @param name
     * @return
     */
     List select(String name);


    /**
     * 翻页查询,调用user.md#pageQuery
     * @param deptId
     * @param pageRequest
     * @return
     */
    PageResult  pageQuery(Integer deptId, PageRequest pageRequest);
    
    @SqlProvider(provider= S01MapperSelectSample.SelectUserProvider.class)
    List queryUserByCondition(String name);

    @SqlTemplateProvider(provider= S01MapperSelectSample.SelectUs
    List queryUserByTemplateCondition(String name);

    @Matcher /*自己定义个Matcher注解也很容易*/
    List query(Condition condition,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 users;
    }

例子9 不同数据库切换

可以自行扩展 ConditionalSQLManager 的 decide 方法，来决定使用哪个 SQLManager

SQLManager a = SampleHelper.init();
        SQLManager b = SampleHelper.init();
        Map 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 = 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 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();
        }
    }