Solon

::fastmybatis-solon-plugin

</> markdown
<dependency>
    <groupId>net.oschina.durcframework</groupId>
    <artifactId>fastmybatis-solon-plugin</artifactId>
    <version>2.10.0</version>
</dependency>

1、描述

数据扩展插件,为 Solon Data 提供基于 fastmybatis(代码仓库)的框架适配,以提供ORM支持。

2、强调多数据源支持

  • 强调多数据源的配置。例:demo.db1...,demo.db2...
  • 强调带 name 的 DataSource Bean
  • 强调使用 @Db("name") 的数据源注解

@Db 可注入类型:

支持类型说明
Mapper.class注入 Mapper。例:@Db("db1") UserMapper userMapper
Configuration注入 Configuration,一般仅用于配置。例:@Db("db1") Configuration db1Cfg
FastmybatisConfig注入 FastmybatisConfig,一般仅用于配置。例:@Db("db1") FastmybatisConfig db1Gc
SqlSessionFactory注入 SqlSessionFactory。例:@Db("db1") SqlSessionFactory db1 (不推荐直接使用)

3、数据源配置

# 配置数据源
demo.db1:
  schema: rock
  jdbcUrl: jdbc:mysql://localhost:3306/rock?useUnicode=true&characterEncoding=utf8&autoReconnect=true&rewriteBatchedStatements=true
  driverClassName: com.mysql.cj.jdbc.Driver
  username: root
  password: 123456
  
# 配置数据源对应的 mybatis 信息(要与 DataSource bean 的名字对上)
mybatis.db1:
    typeAliases:    #支持包名 或 类名(大写开头 或 *)//支持 ** 或 * 占位符
        - "demo4021.model"
        - "demo4021.model.*" #这个表达式同上效果
    typeHandlers: #支持包名 或 类名(大写开头 或 *)//支持 ** 或 * 占位符
        - "demo4021.dso.mybaits.handler"
        - "demo4021.dso.mybaits.handler.*" #这个表达式同上效果
    mappers:        #支持包名 或 类名(大写开头 或 *)或 xml(.xml结尾)//支持 ** 或 * 占位符
        - "demo4021.**.mapper"
        - "demo4021.**.mapper.*" #这个表达式同上效果
        - "classpath:demo4035/**/mapper.xml"
        - "classpath:demo4035/**/mapping/*.xml" 
    configuration:  #扩展配置(要与 Configuration 类的属性一一对应)
        cacheEnabled: false
        mapperVerifyEnabled: false #如果为 true,则要求所有 mapper 有 @Mapper 主解
        mapUnderscoreToCamelCase: true
    globalConfig:   #全局配置(要与 FastmybatisConfig 类的属性一一对应)//只是示例,别照抄
        logicNotDeleteValue: "0"
        disableSqlAnnotation: false


#
#提示:使用 "**" 表达式时,范围要尽量小。不要用 "org.**"、"com.**" 之类的开头,范围太大了,会影响启动速度。
#

configuration、globalConfig 没有对应属性时,可用代码处理

4、关于 mappers 配置的补说明(必看)

  • 思路上,是以数据源为主,去关联对应的 mapper(为了多数据源方便)
  • 如果配置了 xml ,则 xml 对应的 mapper 可以不用配置(会自动关联进去)
mybatis.db1:
    mappers: 
        - "classpath:demo4021/**/mapper.xml"
  • 如果没有对应 xml 文件的 mapper,必须配置一下
mybatis.db1:
    mappers: 
        - "demo4021.**.mapper.*"

5、代码应用

//配置数据源
@Configuration
public class Config {
    //此下的 db1 与 mybatis.db1 将对应在起来 //可以用 @Db("db1") 注入mapper
    //typed=true,表示默认数据源。@Db 可不带名字注入 
    @Bean(value = "db1", typed = true)
    public DataSource db1(@Inject("${demo.db1}") HikariDataSource ds) {
        return ds;
    }
    
    //调整 db1 的配置(如:增加插件)// (配置可以解决的,不需要这块代码)
    //@Bean
    //public void db1_cfg(@Db("db1") org.apache.ibatis.session.Configuration cfg,
    //                    @Db("db1") FastmybatisConfig globalConfig) {

    //    cfg.setCacheEnabled(false);

    //}
}

//应用
@Component
public class AppService{
    //可用 @Db 或 @Db("db1") 注入
    @Db
    AppMapper appMapper; 

    
    public void test(){
        // 根据主键ID查询
        App app = appMapper.getById(12);
    }
    
    
    public List<App> test2() {
    	// SELECT ... FROM app WHERE id in (?,?,?)
        Query query = new Query()
                .in("id", Arrays.asList(4, 5, 6));
        return appMapper.list(query);
    }

    public App test3() {
    	// 根据字段查询某一条数据,通常用于唯一索引字段,如订单编号
    	// SELECT ... FROM app WHERE app_key = ?
        return appMapper.getByColumn("app_key", "xx");
    }

    public void test4() {
        // 子条件查询示例

        // WHERE (id = ? OR id between ? and ?) AND ( money > ? OR state = ? )
        Query query = new Query()
            .and(q -> q.eq("id", 3).orBetween("id", 4, 10))
            .and(q -> q.gt("money", 1).orEq("state", 1
        List<App> apps = appMapper.list(query);

        // WHERE ( id = ? AND username = ? ) OR ( money > ? AND state = ? )
        Query query = new Query()
            .and(q -> q.eq("id", 3).eq("username", "jim"))
            .or(q -> q.gt("money", 1).eq("state", 1));
        List<App> apps = appMapper.list(query);
    }

    public App test5() {
    	// SELECT ... FROM app ORDER BY id desc LIMIT 0, 5
    	// 分页+排序
    	PageSortParam param = new PageSortParam();
        param.setPageIndex(1);
        param.setPageSize(5);
        param.setSort("id");
        param.setOrder("desc");
        Query query = param.toQuery();
        PageInfo<App> page = appMapper.page(query);

        // 不规则分页
        // SELECT ... FROM app LIMIT 1, 2
        OffsetParam param = new OffsetParam();
        param.setStart(1);
        param.setLimit(2);
        Query query = param.toQuery();
        PageInfo<App> page2 = appMapper.page(query);
    }

    public App test6() {
    	// 查询单条数据并返回指定字段并转换到指定类中
    	// SELECT ... FROM app WHERE add_time > ? ORDER BY id DESC LIMIT 1
    	Query query = new Query()
    		.gt("add_time", '2023-05-22')
    		.orderby("id", Sort.DESC);
        AppVO appVO = mapper.getBySpecifiedColumns(Arrays.asList("id", "username"), query, UserVO.class);
        return appVO;
    }

    public void test7() {
        // 返回单值集合,只返回某一列字段值
        // SELECT xx FROM app WHERE username = ?
        Query query = new Query();
        // 添加查询条件
        query.eq("username", "张三");

        // 返回id列
        List<Integer> idList = appMapper.listBySpecifiedColumns(Collections.singletonList("id"), query, Integer.class/* 或int.class */);
    
        // 返回id列,并转换成String
        List<String> strIdList = appMapper.listBySpecifiedColumns(Collections.singletonList("id"), query, String.class);
      
        // 返回username列
        List<String> usernameList = appMapper.listBySpecifiedColumns(Collections.singletonList("username"), query, String.class);
       
		// 返回时间列
        List<Date> dateList = mapper.listBySpecifiedColumns(Collections.singletonList("add_time"), query, Date.class);   
        List<LocalDateTime> date2List = mapper.listBySpecifiedColumns(Collections.singletonList("add_time"), query, LocalDateTime.class);
      

        // 返回decimal列
        List<BigDecimal> moneyList = mapper.listBySpecifiedColumns(Collections.singletonList("money"), query, BigDecimal.class);
    }

    public List<Menu> test8() {
        // 自动转成菜单结构
        /*
        CREATE TABLE `menu` (
          `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '主键id',
          `name` varchar(64) NOT NULL COMMENT '菜单名称',
          `parent_id` int(11) NOT NULL DEFAULT '0' COMMENT '父节点',
          PRIMARY KEY (`id`)
        ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='菜单表';
        */
        // 查询出来的结果已经具备父子关系
        List<Menu> treeData = mapper.listTreeData(query, 0);
    }
    
}

具体可参考: