springboot整合mybatis-plus，代码自动生成

怼烎@ 2022-05-08 00:20 171阅读 0赞

[Mybatis-Plus][]（简称MP）是一个 [Mybatis][] 的增强工具，在 Mybatis 的基础上只做增强不做改变，为简化开发、提高效率而生

特性

*  无侵入：Mybatis-Plus 在 Mybatis 的基础上进行扩展，只做增强不做改变，引入 Mybatis-Plus 不会对您现有的 Mybatis 构架产生任何影响，而且 MP 支持所有 Mybatis 原生的特性
 *  依赖少：仅仅依赖 Mybatis 以及 Mybatis-Spring
 *  损耗小：启动即会自动注入基本CURD，性能基本无损耗，直接面向对象操作
 *  预防Sql注入：内置Sql注入剥离器，有效预防Sql注入攻击
 *  通用CRUD操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求
 *  多种主键策略：支持多达4种主键策略（内含分布式唯一ID生成器），可自由配置，完美解决主键问题
 *  支持ActiveRecord：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可实现基本 CRUD 操作
 *  支持代码生成：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用（P.S. 比 Mybatis 官方的 Generator 更加强大！）
 *  支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）
 *  支持关键词自动转义：支持数据库关键词（order、key……）自动转义，还可自定义关键词
 *  内置分页插件：基于Mybatis物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通List查询
 *  内置性能分析插件：可输出Sql语句以及其执行时间，建议开发测试时启用该功能，能有效解决慢查询
 *  内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，预防误操作

## 基本步骤 ##

添加pom.xml依赖

配置application.yml

配置Druid

使用代码生成器自动生成代码

## 添加pom.xml依赖 ##

<dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>druid</artifactId>
        <version>1.1.3</version>
    </dependency>
    
    
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
    
    
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatisplus-spring-boot-starter</artifactId>
        <version>1.0.5</version>
    </dependency>
    
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus</artifactId>
        <version>2.1.8</version>
    </dependency>
    
    <dependency>
        <groupId>org.apache.velocity</groupId>
        <artifactId>velocity-engine-core</artifactId>
        <version>2.0</version>
    </dependency>
    
    
    
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>1.3.1</version>
    </dependency>

## 配置application.yml ##

# 配置mybatis-plus
    mybatis-plus:
      # 配置扫描xml
      mapper-locations:
        - classpath:mapper/*.xml
      # 实体扫描，多个package用逗号或者分号分隔
      type-aliases-package: com.ahut.entity
      global-config:
        # 逻辑删除配置
        logic-delete-value: 0
        logic-not-delete-value: 1
        sql-injector: com.baomidou.mybatisplus.mapper.LogicSqlInjector

## 使用代码生成器自动生成代码 ##

**代码生成**

package com.ahut.code;
    
    import com.baomidou.mybatisplus.generator.AutoGenerator;
    import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
    import com.baomidou.mybatisplus.generator.config.GlobalConfig;
    import com.baomidou.mybatisplus.generator.config.PackageConfig;
    import com.baomidou.mybatisplus.generator.config.StrategyConfig;
    import com.baomidou.mybatisplus.generator.config.rules.DbType;
    import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
    
    /**
     * 
     * @ClassName: CodeGeneration
     * @Description: 代码生成器
     * @author cheng
     * @date 2018年1月25日 下午2:55:14
     */
    public class CodeGeneration {
    
        /**
         * 
         * @Title: main
         * @Description: 生成
         * @param args
         */
        public static void main(String[] args) {
            AutoGenerator mpg = new AutoGenerator();
    
            // 全局配置
            GlobalConfig gc = new GlobalConfig();
            gc.setOutputDir("E://code");
            gc.setFileOverride(true);
            gc.setActiveRecord(false);// 不需要ActiveRecord特性的请改为false
            gc.setEnableCache(false);// XML 二级缓存
            gc.setBaseResultMap(true);// XML ResultMap
            gc.setBaseColumnList(false);// XML columList
            gc.setAuthor("cheng");// 作者
    
            // 自定义文件命名，注意 %s 会自动填充表实体属性！
            gc.setControllerName("%sAction");
            gc.setServiceName("%sService");
            gc.setServiceImplName("%sServiceImpl");
            gc.setMapperName("%sMapper");
            gc.setXmlName("%sMapper");
            mpg.setGlobalConfig(gc);
    
            // 数据源配置
            DataSourceConfig dsc = new DataSourceConfig();
            dsc.setDbType(DbType.MYSQL);
            dsc.setDriverName("com.mysql.jdbc.Driver");
            dsc.setUsername("root");
            dsc.setPassword("chengrui");
            dsc.setUrl("jdbc:mysql://127.0.0.1:3306/ahutplat");
            mpg.setDataSource(dsc);
    
            // 策略配置
            StrategyConfig strategy = new StrategyConfig();
            strategy.setTablePrefix(new String[] { "sys_" });// 此处可以修改为您的表前缀
            strategy.setNaming(NamingStrategy.underline_to_camel);// 表名生成策略
            strategy.setInclude(new String[] { "sys_user" }); // 需要生成的表
    
            strategy.setSuperServiceClass(null);
            strategy.setSuperServiceImplClass(null);
            strategy.setSuperMapperClass(null);
    
            mpg.setStrategy(strategy);
    
            // 包配置
            PackageConfig pc = new PackageConfig();
            pc.setParent("com.ahut");
            pc.setController("action");
            pc.setService("service");
            pc.setServiceImpl("serviceImpl");
            pc.setMapper("mapper");
            pc.setEntity("entity");
            pc.setXml("xml");
            mpg.setPackageInfo(pc);
    
            // 执行生成
            mpg.execute();
    
        }
    
    }

## 配置Druid ##

**[配置druid过程不变][druid]**

**数据库user表结构如下**  
![这里写图片描述][SouthEast]

**改造得到生成的实体如下**

package com.ahut.entity;
    
    import java.io.Serializable;
    import java.util.Date;
    
    import com.baomidou.mybatisplus.annotations.TableField;
    import com.baomidou.mybatisplus.annotations.TableId;
    import com.baomidou.mybatisplus.annotations.TableName;
    
    /**
     * 
     * @ClassName: User
     * @Description: 用户实体类
     * @author cheng
     * @date 2018年1月25日 下午3:36:06
     */
    @TableName("sys_user")
    public class User implements Serializable {
    
        private static final long serialVersionUID = 1L;
    
        @TableId("ID")
        private String id;
    
        @TableField("USER_NAME")
        private String userName;
    
        @TableField("USER_ACCOUNT")
        private String userAccount;
    
        @TableField("PASSWORD")
        private String password;
    
        @TableField("SORT_ID")
        private Integer sortId;
    
        @TableField("STATUS")
        @TableLogic
        private String status;
    
        @TableField("CREATE_USER")
        private String createUser;
    
        @TableField("CREATE_TIME")
        private Date createTime;
    
        @TableField("UPDATE_USER")
        private String updateUser;
    
        @TableField("UPDATE_TIME")
        private Date updateTime;
    
        public String getId() {
            return id;
        }
    
        public void setId(String id) {
            this.id = id;
        }
    
        public String getUserName() {
            return userName;
        }
    
        public void setUserName(String userName) {
            this.userName = userName;
        }
    
        public String getUserAccount() {
            return userAccount;
        }
    
        public void setUserAccount(String userAccount) {
            this.userAccount = userAccount;
        }
    
        public String getPassword() {
            return password;
        }
    
        public void setPassword(String password) {
            this.password = password;
        }
    
        public Integer getSortId() {
            return sortId;
        }
    
        public void setSortId(Integer sortId) {
            this.sortId = sortId;
        }
    
        public String getStatus() {
            return status;
        }
    
        public void setStatus(String status) {
            this.status = status;
        }
    
        public String getCreateUser() {
            return createUser;
        }
    
        public void setCreateUser(String createUser) {
            this.createUser = createUser;
        }
    
        public Date getCreateTime() {
            return createTime;
        }
    
        public void setCreateTime(Date createTime) {
            this.createTime = createTime;
        }
    
        public String getUpdateUser() {
            return updateUser;
        }
    
        public void setUpdateUser(String updateUser) {
            this.updateUser = updateUser;
        }
    
        public Date getUpdateTime() {
            return updateTime;
        }
    
        public void setUpdateTime(Date updateTime) {
            this.updateTime = updateTime;
        }
    
        @Override
        public String toString() {
            return "User{" + ", id=" + id + ", userName=" + userName + ", userAccount=" + userAccount + ", password="
                    + password + ", sortId=" + sortId + ", status=" + status + ", createUser=" + createUser
                    + ", createTime=" + createTime + ", updateUser=" + updateUser + ", updateTime=" + updateTime + "}";
        }
    }

**serviceImpl层**

package com.ahut.serviceImpl;
    
    import java.util.HashMap;
    import java.util.Map;
    
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Service;
    
    import com.ahut.entity.ReturnBean;
    import com.ahut.entity.User;
    import com.ahut.mapper.UserMapper;
    import com.ahut.service.UserService;
    
    /**
     * 
     * @ClassName: UserServiceImpl
     * @Description: 业务逻辑实现
     * @author cheng
     * @date 2018年1月25日 下午3:58:28
     */
    @Service
    public class UserServiceImpl implements UserService {
    
        /**
         * 日志管理
         */
        private static Logger log = LoggerFactory.getLogger(UserServiceImpl.class);
    
        /**
         * 用户数据访问接口
         */
        @Autowired
        private UserMapper userMapper;
    
        /**
         * 
         * @Title: addUser
         * @Description: 新增用户
         * @param user
         * @return
         * @throws Exception
         */
        public ReturnBean addUser(User user) throws Exception {
            log.info("====>>执行addUser方法");
            ReturnBean returnBean = new ReturnBean();
            // 判断参数
            if (user == null) {
                returnBean.setFailReturn("传入的参数不合法");
                return returnBean;
            }
            // 添加的结果
            int resultNum = 0;
            try {
                // 这里的insert是BaseMapper中的方法
                resultNum = userMapper.insert(user);
            } catch (Exception e) {
                log.error("依据id查找用户时发生异常", e);
                returnBean.setFailReturn("程序内部发生错误");
                return returnBean;
            }
            log.info("添加用户数:" + resultNum);
            if (resultNum == 0) {
                // 添加失败
                returnBean.setFailReturn("添加用户失败");
            } else {
                returnBean.setSuccessReturn("添加用户成功");
            }
            return returnBean;
        }
    
        /**
         * 
         * @Title: selectUserById
         * @Description: 依据id查找用户
         * @param userId
         * @return
         * @throws Exception
         */
        public ReturnBean selectUserById(String userId) throws Exception {
            log.info("====>>执行selectUserById方法");
            ReturnBean returnBean = new ReturnBean();
            // 判断参数是否合法
            if (userId == null || userId == "") {
                returnBean.setFailReturn("传入的参数不合法");
                return returnBean;
            }
            // 查询
            User user = null;
            Map<String, Object> parameterMap = new HashMap<>();
            parameterMap.put("USER_ID", userId);
            try {
                user = userMapper.selectUserByMap(parameterMap);
            } catch (Exception e) {
                log.error("依据id查找用户时发生异常", e);
                returnBean.setFailReturn("程序内部发生错误");
                return returnBean;
            }
            if (user != null) {
                // 查找到了用户信息
                returnBean.setSuccessReturn(user);
            } else {
                returnBean.setFailReturn("没有查找到此用户信息");
            }
            return returnBean;
        }
    
    }

**service层**

package com.ahut.mapper;
    
    import java.util.Map;
    
    import com.ahut.entity.User;
    import com.baomidou.mybatisplus.mapper.BaseMapper;
    
    /**
     * 
     * @ClassName: UserMapper
     * @Description: 用户数据访问接口
     * @author cheng
     * @date 2018年1月25日 下午3:46:22
     */
    public interface UserMapper extends BaseMapper<User> {
    
        /**
         * 
         * @Title: selectUserByMap
         * @Description: 多条件组合查找用户
         * @param userId
         * @return
         * @throws Exception
         */
        User selectUserByMap(Map<String, Object> parameterMap) throws Exception;
    
    }

**改造得到生成的xml如下**

<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
    <mapper namespace="com.ahut.mapper.UserMapper">
    
        <resultMap id="BaseResultMap" type="com.ahut.entity.User">
            <id column="ID" property="id" />
            <result column="USER_NAME" property="userName" />
            <result column="USER_ACCOUNT" property="userAccount" />
            <result column="PASSWORD" property="password" />
            <result column="SORT_ID" property="sortId" />
            <result column="STATUS" property="status" />
            <result column="CREATE_USER" property="createUser" />
            <result column="CREATE_TIME" property="createTime" />
            <result column="UPDATE_USER" property="updateUser" />
            <result column="UPDATE_TIME" property="updateTime" />
        </resultMap>
    
        <select id="selectUserByMap" parameterType="map" resultType="com.ahut.entity.User">
            SELECT
            ID,
            USER_NAME,
            USER_ACCOUNT,
            PASSWORD,
            SORT_ID,
            STATUS,
            CREATE_USER,
            CREATE_TIME,
            UPDATE_USER,
            UPDATE_TIME
            FROM
            SYS_USER
            WHERE STATUS = '1' 
            
            <if test="USER_ID != null and USER_ID != ''">
                AND ID = #{USER_ID}
            </if>
            
            <if test="USER_ACCOUNT != null and USER_ACCOUNT != ''">
                AND USER_ACCOUNT = #{USER_ACCOUNT}
            </if>
        </select>
    
    </mapper>

**改造得到生成的mapper接口如下**

*   
 *   
 *   
 *

**其中ReturnBean为自定义的返回实体类，如下**

package com.ahut.entity;
    
    import java.io.Serializable;
    
    /**
     * 
     * @ClassName: ReturnBean
     * @Description: 返回实体类
     * @author cheng
     * @date 2018年1月25日 下午5:24:54
     */
    public class ReturnBean implements Serializable {
    
        /**
         * 序列化
         */
        private static final long serialVersionUID = -2867756409591322259L;
        /**
         * 返回类型
         */
        private String returnType;
        /**
         * 返回结果
         */
        private Object returnValue;
        /**
         * 成功
         */
        private final String SUCCESS = "SUCCESS";
        /**
         * 失败
         */
        private final String FAIL = "FAIL";
    
        /**
         * 构造函数
         */
        public ReturnBean() {
    
        }
    
        /**
         * toString
         */
        @Override
        public String toString() {
            return "ReturnBean [returnType=" + returnType + ", returnValue=" + returnValue + ", SUCCESS=" + SUCCESS
                    + ", FAIL=" + FAIL + "]";
        }
    
        /**
         * 
         * @Title: setSuccessReturn
         * @Description: 设置成功返回
         * @param returnValue
         */
        public void setSuccessReturn(Object returnValue) {
            this.returnType = this.SUCCESS;
            this.returnValue = returnValue;
        }
    
        /**
         * 
         * @Title: setFailReturn
         * @Description: 设置失败返回
         * @param returnValue
         */
        public void setFailReturn(Object returnValue) {
            this.returnType = this.FAIL;
            this.returnValue = returnValue;
        }
    
        public String getReturnType() {
            return returnType;
        }
    
        public void setReturnType(String returnType) {
            this.returnType = returnType;
        }
    
        public Object getReturnValue() {
            return returnValue;
        }
    
        public void setReturnValue(Object returnValue) {
            this.returnValue = returnValue;
        }
    
    }

##  ##

[Mybatis-Plus]: https://github.com/baomidou/mybatis-plus
[Mybatis]: http://www.mybatis.org/mybatis-3/
[druid]: http://blog.csdn.net/qq_28988969/article/details/78049987
[SouthEast]: /images/20220508/e926129a5d7146abadc84f81bae30721.png