spring boot /spring cloud 集成fluent-mybatis + druid 及案例代码

本文是对《从0到1 手把手搭建spring cloud alibaba 微服务大型应用框架（三） (mini-cloud) 搭建认证服务（认证/资源分离版） oauth2.0 (上)》持久层内容的集成说明部分，也是相对独立的，可以直接参考集成

本文按如下顺序说明
                                                                                                                  

##1. 开发案例需求
##2. 数据表结构
##3. 集成fluent-mybatis +durid 所需pom 以及yml配置
##4. 集成代码生成器
##5. 目录结构
##6. 编译build 生成mapper，helper等
##7. 代码开发
##8. 单元测试验证

1. 开发案例需求 

#本demo 是mini-cloud 中的upms（用户统一权限管理）中心服务 ，流程是从认证中心通过feign 回调upms 获取用户信息进行认证
#本文主要拿两个需求说明
#1.支持通过userid查询用户以及用户所拥有的角色权限（权限暂不在本文处理）
#2.支持通过username查询用户以及用户所拥有的角色权限（权限暂不在本文处理）

2. 数据表结构

因为是demo，尽量用最简单的结构

1.upms_user 用户表

2.upms_role 角色表

3.upms_user_role 用户角色关联表

-- ----------------------------
-- Table structure for upms_role
-- ----------------------------
CREATE TABLE `upms_role` (
  `role_id` int(11) NOT NULL AUTO_INCREMENT,
  `role_name` varchar(64) DEFAULT NULL,
  `role_code` varchar(64) DEFAULT NULL,
  `role_desc` varchar(255) DEFAULT NULL,
  PRIMARY KEY (`role_id`)
) ENGINE=InnoDB AUTO_INCREMENT=23 DEFAULT CHARSET=utf8mb4;

-- ----------------------------
-- Table structure for upms_user
-- ----------------------------
CREATE TABLE `upms_user` (
  `user_id` int(11) NOT NULL AUTO_INCREMENT COMMENT '主键ID',
  `username` varchar(64) DEFAULT NULL,
  `password` varchar(255) DEFAULT NULL,
  PRIMARY KEY (`user_id`)
) ENGINE=InnoDB AUTO_INCREMENT=26 DEFAULT CHARSET=utf8mb4;

-- ----------------------------
-- Table structure for upms_user_role
-- ----------------------------
CREATE TABLE `upms_user_role` (
  `user_id` int(11) NOT NULL COMMENT '用户ID',
  `role_id` int(11) NOT NULL COMMENT '角色ID',
  PRIMARY KEY (`user_id`,`role_id`),
  KEY `user_id` (`user_id`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

3. 集成fluent-mybatis +durid 所需pom 以及yml显示

 <!-- druid 连接池 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
        </dependency>
        <!-- 引入fluent-mybatis 运行依赖包, scope为compile -->
        <dependency>
            <groupId>com.github.atool</groupId>
            <artifactId>fluent-mybatis</artifactId>
        </dependency>
        <!-- 引入fluent-mybatis-processor, scope设置为provider 编译需要，运行时不需要 -->
        <dependency>
            <groupId>com.github.atool</groupId>
            <artifactId>fluent-mybatis-processor</artifactId>
        </dependency>

bootstrap.yml/application.yml

datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    #    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://${MYSQL_HOST:192.168.1.59}:${MYSQL_PORT:3306}/${MYSQL_DB:mini_cloud_auth}?characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=false&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=GMT%2B8&allowMultiQueries=true&allowPublicKeyRetrieval=true
    username: root
    password: root
    driver-class-name: com.mysql.cj.jdbc.Driver
    druid:
      #   Druid数据源配置
      # 初始连接数
      initialSize: 5
      # 最小连接池数量
      minIdle: 10
      # 最大连接池数量
      maxActive: 20
      # 配置获取连接等待超时的时间
      maxWait: 60000
      # 配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒
      timeBetweenEvictionRunsMillis: 60000
      # 配置一个连接在池中最小生存的时间，单位是毫秒
      minEvictableIdleTimeMillis: 300000
      # 配置一个连接在池中最大生存的时间，单位是毫秒
      maxEvictableIdleTimeMillis: 900000
      # 配置检测连接是否有效
      validationQuery: SELECT 1
      #申请连接的时候检测，如果空闲时间大于timeBetweenEvictionRunsMillis，执行validationQuery检测连接是否有效。
      testWhileIdle: true
      #配置从连接池获取连接时，是否检查连接有效性，true每次都检查；false不检查。做了这个配置会降低性能。
      testOnBorrow: false
      #配置向连接池归还连接时，是否检查连接有效性，true每次都检查；false不检查。做了这个配置会降低性能。
      testOnReturn: false
      #打开PsCache，并且指定每个连接上PSCache的大小
      poolPreparedStatements: true
      maxPoolPreparedStatementPerConnectionSize: 20
      #   配置监控统计拦截的filters，去掉后监控界面sql无法统计，'wall'用于防火墙
      #合并多个DruidDatasource的监控数据
      useGlobalDataSourceStat: true
      #通过connectProperties属性来打开mergesql功能罗慢sQL记录
      connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500;

4. 集成代码生成器

 支fluent-mybatis持直接使用代码生成器生成entity 和dao层，后期可以拓展为直接生成service,controller，甚至ui

具体用法以及代码如下，可以直接拷贝改成自己的数据库账号密码以及数据库的表运行即可

package com.minicloud.upms;

import cn.org.atool.generator.FileGenerator;
import cn.org.atool.generator.annotation.Table;
import cn.org.atool.generator.annotation.Tables;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.test.context.junit4.SpringRunner;

/**
 * @Author alan.wang
 * @date: 2022-01-20 16:58
 */
@RunWith(SpringRunner.class)
public class EntityGenerator {

    // 数据源 url
    static final String url =
            "jdbc:mysql://192.168.1.59:3306/mini_cloud_upms?characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=false&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=GMT%2B8&allowMultiQueries=true&allowPublicKeyRetrieval=true";
    // 数据库用户名
    static final String username = "root";
    // 数据库密码
    static final String password = "root";

    @Test
    public void generate() throws Exception {
        // 引用配置类，build方法允许有多个配置类
        FileGenerator.build(Empty.class);
    }

    @Tables(
            // 设置数据库连接信息
            url = url,
            username = username,
            password = password,
            // 设置entity类生成src目录, 相对于 user.dir
            srcDir = "src/main/java",
            // 设置entity类的package值
            basePack = "com.minicloud.upms.entity",
            // 设置dao接口和实现的src目录, 相对于 user.dir
            daoDir = "src/main/java",
            // 设置哪些表要生成Entity文件
            tables = {@Table(value = {"upms_user_role"})})
    static class Empty { // 类名随便取, 只是配置定义的一个载体
    }
}

5. 目录结构

运行上面生成器后如下是生成的目录代码结构，service需要自己去写

6. 编译build 生成mapper，helper等

fluent-mybatis 最大的好处就是不用自己去写xml，mapper等，这些都是编译时自动生成的，我们只需要用就可以了

我们选中项目，build->build/rebuild project

 

自动生成了我们entity 的相关mapper

7. 代码开发

要根据用户id 查询所具有的所有角色正常sql如下

select role_id,role_name,role_desc,role_code from upms_role role inner join upms_user_role urole on urole.role_id = role.role_id where urole.user_id = #userId

 用fluent 开发如下

package com.minicloud.upms.role.dao;

import cn.org.atool.fluent.mybatis.base.crud.IQuery;
import cn.org.atool.fluent.mybatis.base.crud.JoinBuilder;
import com.minicloud.upms.role.dao.base.UpmsRoleBaseDao;
import com.minicloud.upms.role.entity.UpmsRoleEntity;
import com.minicloud.upms.role.wrapper.UpmsRoleQuery;
import com.minicloud.upms.role.wrapper.UpmsUserRoleQuery;
import org.springframework.stereotype.Repository;

import java.util.List;

/**
 * @Author alan.wang
 * @date: 2022-01-20 18:12
 */
@Repository
public class UpmsRoleDaoImpl extends UpmsRoleBaseDao implements UpmsRoleDao{


    /**
     * @desc: 关联upms_role,upms_user_role表查询出指定用户id 的角色
     * */
    @Override
    public List<UpmsRoleEntity> queryRolesByUserId(Integer userId) {

        //select role_id,role_name,role_desc,role_code from upms_role role inner join upms_user_role urole on urole.role_id = role.role_id where urole.user_id = #userId
        IQuery iQuery = JoinBuilder.from(new UpmsRoleQuery("role").select.roleId().roleCode().roleName().roleDesc().end()).
                join(new UpmsUserRoleQuery("urole").where.userId().eq(userId).end()).on(l->l.where.roleId(),r->r.where.roleId()).endJoin().build();

        return this.mapper.listEntity(iQuery);
    }
}

重点是XXQuery 

8. 单元测试验证

package com.minicloud.upms;

import com.minicloud.upms.user.dto.UpmsUserDTO;
import com.minicloud.upms.user.service.UpmsUserService;
import lombok.extern.slf4j.Slf4j;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;


/**
 * @Author alan.wang
 * @date: 2022-01-21 10:54
 */
@Slf4j
@RunWith(SpringRunner.class)
@SpringBootTest(classes = MiniCloudUPMSApplication.class)
public class UpmsUserTest {

    @Autowired
    private UpmsUserService upmsUserService;

    @Test
    public void testQueryUserByUserId(){

        Integer userId = 24;
        UpmsUserDTO upmsUserDTO = upmsUserService.findUserById(userId);
        log.info(upmsUserDTO.toString());
    }

    @Test
    public void testQueryUserByUsername(){

        String username = "user4";
        UpmsUserDTO upmsUserDTO = upmsUserService.findByUsername(username);
        log.info(upmsUserDTO.toString());
    }
}

 运行输出 没问题~，各个业务service需要大家自己的业务端实现，本文主要说明一下整体开发流程