简介：

常见的持久层框架有MyBatis、Spring Data Jpa，BeetlSQL同样也是一款优秀的持久层框架。本章基于 springboot2.0 集成BeetlSQL。

官网地址： http://ibeetl.com/

Beetl： 功能齐全、性能超高、语法简单的模板引擎，而BeetlSQL基于Beetl实现，本章不涉及到Beetl的语法，请到官网学习。

BeetlSQL优势： (来自官网)

构建项目：

1、pom依赖：

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.1.RELEASE</version>
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <!-- Spring Boot Web 依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- Spring Boot Test 依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <!-- lifecycle 只在测试时有效 -->
            <scope>test</scope>
        </dependency>
        <!-- MySQL 连接驱动依赖 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <!--beetlsql-->
        <dependency>
            <groupId>com.ibeetl</groupId>
            <artifactId>beetl-framework-starter</artifactId>
            <version>1.1.63.RELEASE</version>
        </dependency>
        <!-- fastjson 依赖添加 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.31</version>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.2.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.2.2</version>
        </dependency>
        <!--lombok依赖-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.18</version>
        </dependency>
    </dependencies>

2、properties 配置文件：

###### WEB 路径 端口 ######
server.servlet.path=/
server.port=8080

################### beetsql配置 ########################
# 默认是true，即向控制台输出执行时候的sql，参数，执行时间，以及执行的位置，每次修改sql文件的时候，自动检测sql文件修改
beetl-beetlsql.dev=true
# sql 文件的位置
beetlsql.sqlPath=/sql
beetlsql.basePackage=com.coolron
# 默认是org.beetl.sql.core.UnderlinedNameConversion,能将下划线分割的数据库命名风格转化为java驼峰命名风格，
#还有常用的DefaultNameConversion，数据库命名完全和Java命名一直，以及JPA2NameConversion，兼容JPA命名
#beetlsql.nameConversion=DefaultNameConversion
beetlsql.daoSuffix=Dao
beetlsql.dbStyle=org.beetl.sql.core.db.MySqlStyle

################### mysql数据库连接配置 #################
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/springbootdb?useSSL=false&useUnicode=true&characterEncoding=utf8
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

3、beetlsql 配置类(本章暂只配数据库连接信息)：

/**
 * @Description: 数据库配置
 */
@Configuration
public class DataSourceConfig {
    /**
     * BeetlSQL 官方推荐配置
     * 使用的是 Hikari 连接池  springboot2.0 默认支持
     */
    @Bean(name="datasource")
    public DataSource datasource(Environment env) {
        HikariDataSource ds = new HikariDataSource();
        ds.setJdbcUrl(env.getProperty("spring.datasource.url"));
        ds.setUsername(env.getProperty("spring.datasource.username"));
        ds.setPassword(env.getProperty("spring.datasource.password"));
        ds.setDriverClassName(env.getProperty("spring.datasource.driver-class-name"));
        return ds;
    }
  /*  @Bean(name = "datasource")
    public DataSource dataSource(Environment env) {
        String url = env.getProperty("spring.datasource.url");
        String userName = env.getProperty("spring.datasource.username");
        String password = env.getProperty("spring.datasource.password");
        return DataSourceBuilder.create().url(url).username(userName).password(password).build();
    }*/
}

4、新建测试类

/**
 * @Description: 测试 BeetlSQL 内置API
 */
public class BeetlSqlTest {

    public static void main(String[] args) {
        String driver = "com.mysql.jdbc.Driver";
        String url = "jdbc:mysql://127.0.0.1:3306/springbootdb?useSSL=false&useUnicode=true&characterEncoding=utf8";
        String userName = "root";
        String password = "root";

        ConnectionSource source = ConnectionSourceHelper.getSimple(driver, url, userName, password);
        DBStyle mysql = new MySqlStyle();
        // sql语句放在classpagth的/sql 目录下
        SQLLoader loader = new ClasspathLoader("/sql");
        // 数据库命名跟java命名一样，所以采用DefaultNameConversion，还有一个是UnderlinedNameConversion，下划线风格的，
        UnderlinedNameConversion nc = new  UnderlinedNameConversion();

        /**
         * 创建一个SQLManager,DebugInterceptor 不是必须的，但可以通过它查看sql执行情况
         * SQLManager 是系统的核心，他提供了所有的dao方法。获得SQLManager，可以直接构造SQLManager
         */
        SQLManager sqlManager = new SQLManager(mysql,loader,source,nc,new Interceptor[]{new DebugInterceptor()});
         /*
         sqlManager 内置api 用于生产 pojo 和 SQL
         */
         /*
        genPojoCodeToConsole(String table), 根据表名生成pojo类，输出到控制台.
        genPojoCode(String table,String pkg,String srcPath,GenConfig config) 根据表名，包名，生成路径，还有配置，生成pojo代码
        genPojoCode(String table,String pkg,GenConfig config) 同上，生成路径自动是项目src路径，或者src/main/java (如果是maven工程)
        genPojoCode(String table,String pkg),同上，采用默认的生成配置

         genSQLTemplateToConsole(String table),生成查询，条件，更新sql模板，输出到控制台。
        genSQLFile(String table), 同上，但输出到工程，成为一个sql模版,sql模版文件的位置在src目录下，或者src／main／resources（如果是maven）工程.
        genALL(String pkg,GenConfig config,GenFilter filter) 生成所有的pojo代码和sql模版，
        genBuiltInSqlToConsole(Class z) 根据类来生成内置的增删改查sql语句，并打印到控制台
        */
        try {
            //sql.genPojoCodeToConsole("userRole"); 快速生成，显示到控制台
            // 或者直接生成java文件
            // config 类用来配置生成喜好,目前支持生成pojo是否继承某个基类, 是否用BigDecimal代替Double,是否采用Date而不是Timestamp来表示日期，是否是直接输出到控制台而不是文件等
            //GenConfig config = new GenConfig();
            //config.preferBigDecimal(true);
            // 是否继承某个类
            //config.setBaseClass("com.coolron.test.User");
            //sqlManager.genPojoCode("user","com.coolron.test",config);

            // 生产 实体类
            //sqlManager.genPojoCodeToConsole("user");
            // 生成 SQL
            sqlManager.genSQLTemplateToConsole("user");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

运行main方法 可以在控制台输出实体类、SQL，拷贝到对应文件即可。

5、新建controller、service、dao层。
分别使用 BaseMapper、Query查询器、sqlId 做一个示例

5.1、新建controller

@RestController
@RequestMapping(value = "/user")
public class UserController {
    @Autowired
    private UserService userService;
    /**
     * 使用 BaseMapper 查询
     * @param id
     * @return
     */
    @GetMapping(value = "/getUserInfo/{id}")
    public User getUserInfo(@PathVariable Integer id) {
        return userService.getUserInfo(id);
    }
    /**
     * 使用Query 查询器查询   单表操作建议使用
     * @param keyword
     * @return
     */
    @GetMapping(value = "/getUserListQuery")
    public List<User> getUserListQuery(@RequestParam(value = "keyword", required = false) String keyword) {
        return userService.getUserListQuery(keyword);
    }
    /**
     * 使用 sqlId 查询
     */
    @GetMapping(value = "/getUserListSqlId")
    public List<User> getUserListSqlId(@RequestParam(value = "keyword", required = false) String keyword) {
        return userService.getUserListSqlId(keyword);
    }
    @GetMapping(value = "/getUserListPageQuery")
    public PageQuery getUserListPageQuery(@RequestParam(value = "pageNumber", required = false,defaultValue = "1") int pageNumber,
                                          @RequestParam(value = "pageSize", required = false, defaultValue = "10") int pageSize,
                                          @RequestParam(value = "name", required = false) String name) {

        // 构造不一定要这样 可参看PageQuery构造器
        PageQuery<User> query = new PageQuery(pageNumber, pageSize);
        //query.setPageSize(5);
        // 过滤条件
        Map<String,Object> paras = new HashMap<String,Object>(1);
        paras.put("name", name);
        query.setParas(paras);

        System.out.println(query.getTotalPage());
        System.out.println(query.getTotalRow());
        System.out.println(query.getPageNumber());
        List<User> list = query.getList();

        return userService.getUserListPageQuery(query);
    }
}

5.2、service

@Service
public class UserServiceImpl implements UserService {
    @Autowired
    private UserDao userDao;
    @Autowired
    SQLManager sqlManager;
    /**
     * 使用 BaseMapper 查询
     */
    @Override
    public User getUserInfo(Integer id){
        return userDao.unique(id);
    }
    /**
     * Query查询器
     *  针对单表进行操作 建议使用
     */
    @Override
    public List<User> getUserListQuery(String keyword) {
//        Query<User> query = sqlManager.query(User.class);
//        List<User> list = query.andBetween("id", 1, 1640)
//                .andLike("name", "%t%")
//                .andIsNotNull("create_time")
//                .orderBy("id desc").select();
        Query<User> query = sqlManager.query(User.class);
        List<User> list = query.andLike("name", "%"+ keyword + "%")
                .orderBy("id desc").select();
        return list;
    }
    /**
     * 使用 sqlId 查询
     */
    @Override
    public List<User> getUserListSqlId(String keyword) {
        return userDao.selectUserByName(keyword);
    }
    /**
     * PageQuery
     */
    @Override
    public PageQuery getUserListPageQuery(PageQuery query) {
        userDao.getUserListPageQuery(query);
        return query;
    }
}

5.3、dao

/**
 * BaseMapper包含了内置的常用 CRUD
 */
// 通过@SqlResource 注解来指定Mapper对应的sql文件 user.md 文件
// @SqlResource("ron.user")  多级目录
@SqlResource("user")
public interface UserDao extends BaseMapper<User> {
    // JDK 1.8 可不加@Param  但java编译的时候开启-parameters选项
    List<User> selectUserByName(@Param("name") String name);
    void getUserListPageQuery(PageQuery query);
}

5.4、在resources下创建sql文件夹，新建user.md文件用于存放SQL。
user.md 新建几个简单的查询

select
===
* @ 和回车符号是定界符号，可以在里面写beetl语句。
* isEmpty是beetl的一个函数，用来判断变量是否为空或者是否不存在
* "#" 是占位符号
* 文件名约定为类名，首字母小写
select * from user where 1=1
@if(!isEmpty(age)){
and age = #age#
@}
@if(!isEmpty(name)){
and name = #name#
@}

getUserListPageQuery
===
    select  
    @pageTag(){
        a.*
    @}  
    FROM  user a
    where  #use("condition")#
  
selectUserByName
===
* 根据name获user
    select * from user where name= #name#

sample
===
* 注释

    select #use("cols")# from user  where  #use("condition")#

cols
===
    id,age,name,description,cityId

updateSample
===
    id=#id#,age=#age#,name=#name#,description=#description#,cityId=#cityid#

condition
===
    1 = 2  
    @if(!isEmpty(id)){
     and id=#id#
    @}
    @if(!isEmpty(age)){
     and age=#age#
    @}
    @if(!isEmpty(name)){
     and name like #'%'+name+'%'#
    @}
    @if(!isEmpty(description)){
     and description=#description#
    @}
    @if(!isEmpty(cityid)){
     and cityId=#cityid#
    @}

6、测试
可以在控制台看到SQL语句执行信息

6.1、BaseMapper 测试：localhost:8080/user/getUserInfo/1 获取到数据。

┏━━━━━ Debug [user._gen_selectById] ━━━
┣ SQL：   select * from `springbootdb`.`user` where `id` = ?
┣ 参数：    [1]
┣ 位置：    com.coolron.user.service.impl.UserServiceImpl.getUserInfo(UserServiceImpl.java:30)
┣ 时间：    25ms
┣ 结果：    [com.coolron.user.domain.User@3067b8b6]
┗━━━━━ Debug [user._gen_selectById] ━━━

6.2、Query 查询器测试：localhost:8080/user/getUserListQuery?keyword=r

┏━━━━━ Debug [native.SELECT * FROM `springbootdb`.`user` WHERE `...] ━━━
┣ SQL：   SELECT * FROM `springbootdb`.`user` WHERE `name` LIKE ? ORDER BY id desc 
┣ 参数：    [%r%]
┣ 位置：    org.beetl.sql.core.query.Query.selectByType(Query.java:137)
┣ 时间：    4ms
┣ 结果：    [1]
┗━━━━━ Debug [native.SELECT * FROM `springbootdb`.`user` WHERE `...] ━━━

6.3、sqlId测试，即在user.md中定义的。
接口：localhost:8080/user/getUserListPageQuery?name=r 分页查询，返回PageQuery对象。

┏━━━━━ Debug [user.getUserListPageQuery] ━━━
┣ SQL：    select count(1) FROM user a where 1 = 2 and name like ? 
┣ 参数：    [%r%]
┣ 位置：    com.coolron.user.service.impl.UserServiceImpl.getUserListPageQuery(UserServiceImpl.java:60)
┣ 时间：    4ms
┣ 结果：    [1]
┗━━━━━ Debug [user.getUserListPageQuery] ━━━

至此，基本的baseMapper、Query查询器、sqlid三种方式的查询完成。

总结：
1、BeetlSQL 的 basemapper、query查询器是封装好的，其核心是SQLManager。
2、sqlId查询需指定写SQL语句，其SQL模板是基于Beetl语法的。
3、sqlId的方式在Dao层使用@SqlResource("user")指定SQL文件的位置，注意本文中此注解指定路径时没有指定/sql 文件夹，是其在配置文件中指定了。
4、实体类、SQL语句的生成可在测试类中查看相关API。

代码地址：
https://gitee.com/cpla026/beetlsql/tree/master/springboot-beetlsql

个人学习分享
更多 springboot、springcloud、docker 文章关注微信公众号吧：

A罗恩和Java