springboot整合 beatlsql的实例代码

beetsql是一个全功能dao工具， 同时具有hibernate 优点 & mybatis优点功能，适用于承认以sql为中心，同时又需求工具能自动能生成大量常用的sql的应用。

beatlsql 优点

• 开发效率
  • 无需注解，自动使用大量内置sql，轻易完成增删改查功能，节省50%的开发工作量
  • 数据模型支持pojo，也支持map/list这种快速模型，也支持混合模型
  • sql 模板基于beetl实现，更容易写和调试，以及扩展
• 维护性
  • sql 以更简洁的方式，markdown方式集中管理，同时方便程序开发和数据库sql调试。
  • 可以自动将sql文件映射为dao接口类
  • 灵活直观的支持支持一对一，一对多，多对多关系映射而不引入复杂的or mapping概念和技术。
  • 具备interceptor功能，可以调试，性能诊断sql，以及扩展其他功能
• 其他
  • 内置支持主从数据库支持的开源工具
  • 支持跨数据库平台，开发者所需工作减少到最小，目前跨数据库支持mysql,postgres,oracle,sqlserver,h2,sqllite,db2.
    

引入依赖

<dependency>
      <groupid>org.springframework.boot</groupid>
      <artifactid>spring-boot-devtools</artifactid>
      <optional>true</optional>
    </dependency>
    <dependency>
      <groupid>com.ibeetl</groupid>
      <artifactid>beetl</artifactid>
      <version>2.3.2</version>

    </dependency>

    <dependency>
      <groupid>com.ibeetl</groupid>
      <artifactid>beetlsql</artifactid>
      <version>2.3.1</version>

    </dependency>

    <dependency>
      <groupid>mysql</groupid>
      <artifactid>mysql-connector-java</artifactid>
      <version>5.0.5</version>
    </dependency>

这几个依赖都是必须的。

整合阶段

由于springboot没有对 beatlsql的快速启动装配，所以需要我自己导入相关的bean，包括数据源，包扫描，事物管理器等。

在application加入以下代码：

@bean(initmethod = "init", name = "beetlconfig")
  public beetlgrouputilconfiguration getbeetlgrouputilconfiguration() {
    beetlgrouputilconfiguration beetlgrouputilconfiguration = new beetlgrouputilconfiguration();
    resourcepatternresolver patternresolver = resourcepatternutils.getresourcepatternresolver(new defaultresourceloader());
    try {
      // webappresourceloader 配置root路径是关键
      webappresourceloader webappresourceloader = new webappresourceloader(patternresolver.getresource("classpath:/templates").getfile().getpath());
      beetlgrouputilconfiguration.setresourceloader(webappresourceloader);
    } catch (ioexception e) {
      e.printstacktrace();
    }
    //读取配置文件信息
    return beetlgrouputilconfiguration;

  }

  @bean(name = "beetlviewresolver")
  public beetlspringviewresolver getbeetlspringviewresolver(@qualifier("beetlconfig") beetlgrouputilconfiguration beetlgrouputilconfiguration) {
    beetlspringviewresolver beetlspringviewresolver = new beetlspringviewresolver();
    beetlspringviewresolver.setcontenttype("text/html;charset=utf-8");
    beetlspringviewresolver.setorder(0);
    beetlspringviewresolver.setconfig(beetlgrouputilconfiguration);
    return beetlspringviewresolver;
  }

  //配置包扫描
  @bean(name = "beetlsqlscannerconfigurer")
  public beetlsqlscannerconfigurer getbeetlsqlscannerconfigurer() {
    beetlsqlscannerconfigurer conf = new beetlsqlscannerconfigurer();
    conf.setbasepackage("com.forezp.dao");
    conf.setdaosuffix("dao");
    conf.setsqlmanagerfactorybeanname("sqlmanagerfactorybean");
    return conf;
  }

  @bean(name = "sqlmanagerfactorybean")
  @primary
  public sqlmanagerfactorybean getsqlmanagerfactorybean(@qualifier("datasource") datasource datasource) {
    sqlmanagerfactorybean factory = new sqlmanagerfactorybean();

    beetlsqldatasource source = new beetlsqldatasource();
    source.setmastersource(datasource);
    factory.setcs(source);
    factory.setdbstyle(new mysqlstyle());
    factory.setinterceptors(new interceptor[]{new debuginterceptor()});
    factory.setnc(new underlinednameconversion());//开启驼峰
    factory.setsqlloader(new classpathloader("/sql"));//sql文件路径
    return factory;
  }


  //配置数据库
  @bean(name = "datasource")
  public datasource getdatasource() {
    return datasourcebuilder.create().url("jdbc:mysql://127.0.0.1:3306/test").username("root").password("123456").build();
  }

  //开启事务
  @bean(name = "txmanager")
  public datasourcetransactionmanager getdatasourcetransactionmanager(@qualifier("datasource") datasource datasource) {
    datasourcetransactionmanager dsm = new datasourcetransactionmanager();
    dsm.setdatasource(datasource);
    return dsm;
  }

在resouces包下，加meta_inf文件夹，文件夹中加入spring-devtools.properties:

restart.include.beetl=/beetl-2.3.2.jar
restart.include.beetlsql=/beetlsql-2.3.1.jar

在templates下加一个index.btl文件。

加入jar和配置beatlsql的这些bean，以及resources这些配置之后，springboot就能够访问到数据库类。

举个restful的栗子

初始化数据库的表

# drop table `account` if exists
create table `account` (
 `id` int(11) not null auto_increment,
 `name` varchar(20) not null,
 `money` double default null,
 primary key (`id`)
) engine=innodb auto_increment=4 default charset=utf8;
insert into `account` values ('1', 'aaa', '1000');
insert into `account` values ('2', 'bbb', '1000');
insert into `account` values ('3', 'ccc', '1000');

bean

public class account {
  private int id ;
  private string name ;
  private double money;

  getter...

  setter...

 } 

数据访问dao层

public interface accountdao extends basemapper<account> {

  @sqlstatement(params = "name")
  account selectaccountbyname(string name);
}

接口继承basemapper，就能获取单表查询的一些性质，当你需要自定义sql的时候，只需要在resouses/sql/account.md文件下书写文件：

selectaccountbyname
===
*根据name获account

  select * from account where name= #name#

其中“=== ”上面是唯一标识，对应于接口的方法名，“* ”后面是注释，在下面就是自定义的sql语句，具体的见官方文档。

web层

这里省略了service层，实际开发补上。

@restcontroller
@requestmapping("/account")
public class accountcontroller {

  @autowired
  accountdao accountdao;

  @requestmapping(value = "/list",method = requestmethod.get)
  public list<account> getaccounts(){
    return accountdao.all();
  }

  @requestmapping(value = "/{id}",method = requestmethod.get)
  public account getaccountbyid(@pathvariable("id") int id){
    return accountdao.unique(id);
  }

  @requestmapping(value = "",method = requestmethod.get)
  public account getaccountbyid(@requestparam("name") string name){
    return accountdao.selectaccountbyname(name);
  }

  @requestmapping(value = "/{id}",method = requestmethod.put)
  public string updateaccount(@pathvariable("id")int id , @requestparam(value = "name",required = true)string name,
  @requestparam(value = "money" ,required = true)double money){
    account account=new account();
    account.setmoney(money);
    account.setname(name);
    account.setid(id);
    int t=accountdao.updatebyid(account);
    if(t==1){
      return account.tostring();
    }else {
      return "fail";
    }
  }

  @requestmapping(value = "",method = requestmethod.post)
  public string postaccount( @requestparam(value = "name")string name,
                 @requestparam(value = "money" )double money) {
    account account = new account();
    account.setmoney(money);
    account.setname(name);
    keyholder t = accountdao.insertreturnkey(account);
    if (t.getint() > 0) {
      return account.tostring();
    } else {
      return "fail";
    }
  }
}

通过postman 测试，代码已全部通过。

个人使用感受，使用bealsql做了一些项目的试验，但是没有真正用于真正的生产环境，用起来非常的爽。但是springboot没有提供自动装配的直接支持，需要自己注解bean。另外使用这个orm的人不太多，有木有坑不知道，在我使用的过程中没有遇到什么问题。另外它的中文文档比较友好。

源码下载：https://github.com/forezp/springbootlearning

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。