Spring Boot整合Mybatis项目基本骨架（包括分页，mbg代码生成）

项目基本目录

注意：resources下的mbg生成的mapper.xml的文件夹不用建，自动生成

新建Spring Boot项目

新建Spring Boot项目，取好项目目录名和项目名，一路Next

pom.xml

添加项目相关依赖

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.3.RELEASE</version>
        <relativePath/>
</parent>
<dependencies>
        <!--SpringBoot通用依赖模块-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!--MyBatis分页插件-->
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper-spring-boot-starter</artifactId>
            <version>1.2.10</version>
        </dependency>
        <!--集成druid连接池-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.1.10</version>
        </dependency>
        <!-- MyBatis 生成器 -->
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.7</version>
        </dependency>
        <!--Mysql数据库驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.15</version>
        </dependency>
    </dependencies>

注：只要整合了PagerHelper就自动整合了MyBatis。

application.yml

配置端口、数据源、扫描路径

server:
  port: 8080
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/deliverysystem?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai&zeroDateTimeBehavior=CONVERT_TO_NULL
    username: root
    password: root
    driver-class-name: com.mysql.cj.jdbc.Driver
mybatis:
  mapper-locations:
    - classpath:mapper/*.xml
    - classpath*:com/**/mapper/*.xml

新建包和文件

注：resources下的mbg生成的mapper.xml的文件不用建，自动生成

generator.properties

代码生成器数据源配置

# jdbc
jdbc.driverClass = com.mysql.cj.jdbc.Driver
jdbc.connectionURL = jdbc:mysql://localhost:3306/deliverysystem?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai&zeroDateTimeBehavior=CONVERT_TO_NULL
jdbc.userId = root
jdbc.password = root

jdbc.maxPoolSize=50
jdbc.minPoolSize=10
jdbc.maxStatements=100
jdbc.testConnection=true

# mapper
# mapper.plugin = tk.mybatis.mapper.generator.MapperPlugin
# mapper.Mapper = com.jonychen.common.utils.CustomerMapper

MyCommentGenerator.java

自定义代码注释生成器

import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.dom.java.CompilationUnit;
import org.mybatis.generator.api.dom.java.Field;
import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
import org.mybatis.generator.internal.DefaultCommentGenerator;
import org.mybatis.generator.internal.util.StringUtility;
import java.util.Properties;

/**
 * 自定义注释生成器
 */
public class MyCommentGenerator extends DefaultCommentGenerator {
    private boolean addRemarkComments = false;
    private static final String EXAMPLE_SUFFIX="Example";
   // private static final String API_MODEL_PROPERTY_FULL_CLASS_NAME="io.swagger.annotations.ApiModelProperty";

    /**
     * 设置用户配置的参数
     */
    @Override
    public void addConfigurationProperties(Properties properties) {
        super.addConfigurationProperties(properties);
        this.addRemarkComments = StringUtility.isTrue(properties.getProperty("addRemarkComments"));
    }

    /**
     * 给字段添加注释
     */
    @Override
    public void addFieldComment(Field field, IntrospectedTable introspectedTable,
                                IntrospectedColumn introspectedColumn) {
        String remarks = introspectedColumn.getRemarks();
        //根据参数和备注信息判断是否添加备注信息
        if(addRemarkComments&&StringUtility.stringHasValue(remarks)){
//            addFieldJavaDoc(field, remarks);
            //数据库中特殊字符需要转义
            if(remarks.contains("\"")){
                remarks = remarks.replace("\"","'");
            }
            //给model的字段添加swagger注解
            //field.addJavaDocLine("@ApiModelProperty(value = \""+remarks+"\")");
        }
    }

    /**
     * 给model的字段添加注释
     */
    private void addFieldJavaDoc(Field field, String remarks) {
        //文档注释开始
        field.addJavaDocLine("/**");
        //获取数据库字段的备注信息
        String[] remarkLines = remarks.split(System.getProperty("line.separator"));
        for(String remarkLine:remarkLines){
            field.addJavaDocLine(" * "+remarkLine);
        }
        addJavadocTag(field, false);
        field.addJavaDocLine(" */");
    }

   /* @Override
    public void addJavaFileComment(CompilationUnit compilationUnit) {
        super.addJavaFileComment(compilationUnit);
        //只在model中添加swagger注解类的导入
        if(!compilationUnit.isJavaInterface()&&!compilationUnit.getType().getFullyQualifiedName().contains(EXAMPLE_SUFFIX)){
            compilationUnit.addImportedType(new FullyQualifiedJavaType(API_MODEL_PROPERTY_FULL_CLASS_NAME));
        }
    }*/
}

generatorConfig.xml

代码自动生成配置

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

<generatorConfiguration>
    <!--加载配置文件，为下面读取数据库信息准备-->
    <properties resource="generator.properties"/>
    <!--
   context:生成一组对象的环境
   id:必选，上下文id，用于在生成错误时提示
   defaultModelType:指定生成对象的样式
       1，conditional：类似hierarchical；
       2，flat：所有内容（主键，blob）等全部生成在一个对象中；
       3，hierarchical：主键生成一个XXKey对象(key class)，Blob等单独生成一个对象，其他简单属性在一个对象中(record class)
   targetRuntime:
       1，MyBatis3：默认的值，生成基于MyBatis3.x以上版本的内容，包括XXXBySample
       2，MyBatis3Simple：类似MyBatis3，只是不生成XXXBySample；
   introspectedColumnImpl：类全限定名，用于扩展MBG
    -->
    <context id="MySqlContext" targetRuntime="MyBatis3" defaultModelType="flat">
        <!-- beginningDelimiter和endingDelimiter：指明数据库的用于标记数据库对象名的符号，比如ORACLE就是双引号，MYSQL默认是`反引号-->
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <!-- 生成的Java文件的编码 -->
        <property name="javaFileEncoding" value="UTF-8"/>
        <!-- 为模型生成序列化方法-->
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
        <!-- 为生成的Java模型创建一个toString方法 -->
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
        <!--覆盖生成XML文件--><!--注意：这个pom.xml中MyBatis 生成器1.3.7版本才有-->
        <plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" />
        <!--可以自定义生成model的代码注释-->
        <!-- 阻止生成自动注释 -->
        <commentGenerator type="com.gxwz.deliverysystem.mbg.MyCommentGenerator">
            <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
            <property name="javaFileEncoding" value="UTF-8"/>
            <property name="suppressDate" value="true"/>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <!--配置数据库连接-->
        <jdbcConnection driverClass="${jdbc.driverClass}"
                        connectionURL="${jdbc.connectionURL}"
                        userId="${jdbc.userId}"
                        password="${jdbc.password}">
            <!--解决mysql驱动升级到8.0后不生成指定数据库代码的问题-->
            <property name="nullCatalogMeansCurrent" value="true" />
        </jdbcConnection>
        <!--指定生成model的路径--><!--targetProject="E:\ideaworkspace\mallstudy\src\main\java" (填绝对路径)-->
        <javaModelGenerator targetPackage="com.gxwz.deliverysystem.mbg.model" targetProject="E:\ideaworkspace\deliverysystem\src\main\java"/>
        <!--指定生成mapper.xml的路径-->
        <sqlMapGenerator targetPackage="com.gxwz.deliverysystem.mbg.mapper" targetProject="E:\ideaworkspace\deliverysystem\src\main\resources"/>
        <!--指定生成mapper接口的的路径-->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.gxwz.deliverysystem.mbg.mapper"
                             targetProject="E:\ideaworkspace\deliverysystem\src\main\java"/>


        <!--生成全部表tableName设为%-->
        <!--<table tableName="%">
            <generatedKey column="id" sqlStatement="MySql" identity="true"/>
        </table>-->
        <!--要Example-->
        <table tableName="pms_brand">
            <generatedKey column="id" sqlStatement="MySql" identity="true"/>
        </table>
        <!--不要Example-->
        <!--<table tableName="cms_help" enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false"
               selectByExampleQueryId="false">
            <generatedKey column="id" sqlStatement="MySql" identity="true"/>
        </table>-->

    </context>
</generatorConfiguration>

Generator.java

代码生成器启动类

import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.internal.DefaultShellCallback;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;

/**
 * 用于生产MBG的代码
 * Created by macro on 2018/4/26.
 */
public class Generator {
    public static void main(String[] args) throws Exception {
        //MBG 执行过程中的警告信息
        List<String> warnings = new ArrayList<String>();
        //当生成的代码重复时，覆盖原代码
        boolean overwrite = true;
        //读取我们的 MBG 配置文件
        InputStream is = Generator.class.getResourceAsStream("/generatorConfig.xml");
        ConfigurationParser cp = new ConfigurationParser(warnings);
        Configuration config = cp.parseConfiguration(is);
        is.close();

        DefaultShellCallback callback = new DefaultShellCallback(overwrite);
        //创建 MBG
        MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
        //执行生成代码
        myBatisGenerator.generate(null);
        //输出警告信息
        for (String warning : warnings) {
            System.out.println(warning);
        }
    }
}

运行Generator自动生成代码

---

MybatisConfig.java

用于配置需要动态生成的mapper接口的路径

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Configuration;

/**
 * MyBatis配置类
 * Created by macro on 2019/4/8.
 */
@Configuration
@MapperScan("com.gxwz.deliverysystem.mbg.mapper")
public class MyBatisConfig {

}

编写Service接口

import com.gxwz.deliverysystem.mbg.model.User;
import java.util.List;

/**
 * @author fengxiao
 * @date 2020/2/23 17:28
 */
public interface UserService {

    int createUser(User user);

    int deleteUser(Long id);

    int updateUser(Long id, User user);

    List<User> listAllUser();

    List<User> listUser(int pageNum, int pageSize);

    User getUser(Long id);
}

编写Service接口实现类

import com.github.pagehelper.PageHelper;
import com.gxwz.deliverysystem.mbg.mapper.UserMapper;
import com.gxwz.deliverysystem.mbg.model.User;
import com.gxwz.deliverysystem.mbg.model.UserExample;
import com.gxwz.deliverysystem.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import java.util.List;

/**
 * @author fengxiao
 * @date 2020/2/23 17:36
 */
public class UserServiceImpl implements UserService {

    @Autowired
    private UserMapper userMapper;

    @Override
    public int createUser(User user){
        return userMapper.insert(user);
    }

    @Override
    public int deleteUser(Long id){
        return userMapper.deleteByPrimaryKey(id);
    }

    @Override
    public int updateUser(Long id, User user){
        user.setId(id);
        return userMapper.updateByPrimaryKey(user);
    }

    @Override
    public List<User> listAllUser(){
        return userMapper.selectByExample(new UserExample());
    }
    
    //分页显示
    @Override
    public List<User> listUser(int pageNum, int pageSize){
        PageHelper.startPage(pageNum, pageSize);
        return userMapper.selectByExample(new UserExample());
    }

    @Override
    public User getUser(Long id){
        return userMapper.selectByPrimaryKey(id);
    }
}

添加common.api

包括对分页数据和返回结果的封装类

编写Controller

import com.gxwz.deliverysystem.common.api.CommonPage;
import com.gxwz.deliverysystem.common.api.CommonResult;
import com.gxwz.deliverysystem.mbg.model.User;
import com.gxwz.deliverysystem.service.UserService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.*;
import java.util.List;

/**
 * @author fengxiao
 * @date 2020/2/23 18:00
 */
@Controller
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

    private static final Logger LOGGER = LoggerFactory.getLogger(UserController.class);

    /**
     * 获取所有User
     * @return
     */
    @RequestMapping(value = "/listAll", method = RequestMethod.GET)
    @ResponseBody
    public CommonResult<List<User>> getUserlist(){
        return CommonResult.success(userService.listAllUser());  //成功时返回结果对象
    }

    /**
     * 添加User
     * @param user
     * @return
     */
    @RequestMapping(value = "/create", method = RequestMethod.POST)
    @ResponseBody
    public CommonResult createUser(@RequestBody User user) {
        CommonResult commonResult;
        int count = userService.createUser(user);
        if (count == 1) {
            commonResult = CommonResult.success(user);
            LOGGER.debug("createUser success:{}", user);
        } else {
            commonResult = CommonResult.failed("操作失败");
            LOGGER.debug("createUser failed:{}", user);
        }
        return commonResult;
    }

    /**
     * 根据id修改User
     * @param id
     * @param user
     * @param result
     * @return
     */
    @RequestMapping(value = "/update/{id}", method = RequestMethod.POST)
    @ResponseBody
    public CommonResult updateUser(@PathVariable("id") Long id, @RequestBody User user, BindingResult result) {
        CommonResult commonResult;
        int count = userService.updateUser(id, user);
        if (count == 1) {
            commonResult = CommonResult.success(user);
            LOGGER.debug("updateUser success:{}", user);
        } else {
            commonResult = CommonResult.failed("操作失败");
            LOGGER.debug("updateUser failed:{}", user);
        }
        return commonResult;
    }

    /**
     * 根据id删除User
     * @param id
     * @return
     */
    @RequestMapping(value = "/delete/{id}", method = RequestMethod.GET)
    @ResponseBody
    public CommonResult deleteUser(@PathVariable("id") Long id) {
        int count = userService.deleteUser(id);
        if (count == 1) {
            LOGGER.debug("deleteUser success :id={}", id);
            return CommonResult.success("操作成功");
        } else {
            LOGGER.debug("deleteUser failed :id={}", id);
            return CommonResult.failed("操作失败");
        }
    }

    /**
     * 分页获取User
     * @param pageNum
     * @param pageSize
     * @return
     */
    @RequestMapping(value = "/list", method = RequestMethod.GET)
    @ResponseBody
    public CommonResult<CommonPage<User>> listBrand(@RequestParam(value = "pageNum", defaultValue = "1") Integer pageNum,
                                                        @RequestParam(value = "pageSize", defaultValue = "5") Integer pageSize) {
        List<User> userList = userService.listUser(pageNum, pageSize);
        return CommonResult.success(CommonPage.restPage(userList));
    }

    /**
     * 根据id获取User
     * @param id
     * @return
     */
    @RequestMapping(value = "/{id}", method = RequestMethod.GET)
    @ResponseBody
    public CommonResult<User> brand(@PathVariable("id") Long id) {
        return CommonResult.success(userService.getUser(id));
    }

}

运行项目启动类测试