初学SpringBoot三【SpringBoot整合Mybatis&properties中的key命名规则】

---

前言

本文章主要讲解SpringBoot整合Mybatis的步骤

---

一、SpirngBoot整合Mybatis

一说到整合Mybatis，我想大家都瞬间回想起以前用Spring整合Mybatis时，那一大推令人头皮发麻的配置信息，不过这次不用担心了，应为我们这次试用的是超级快捷方便的SpringBoot。有多方便呢？大家看一下就知道有多简单省事了。。。

1、环境搭建并完成CRUD

添加maven依赖

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>

   <groupId>org.example</groupId>
   <artifactId>springBootMybatis</artifactId>
   <version>1.0-SNAPSHOT</version>
   <packaging>war</packaging>

   <name>springBootMybatis</name>
   <!-- FIXME change it to the project's website -->
   <url>http://www.example.com</url>
   <!-- 第一步：添加spring-boot-starter-parent 这是作为SpringBoot的基础依赖包 -->
   <parent>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-parent</artifactId>
       <version>2.4.0</version>
   </parent>

   <dependencies>
       <!-- 为了测试方便，导入SpringBoot启动器 -->
       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-web</artifactId>
       </dependency>
       <dependency>
           <groupId>org.mybatis.spring.boot</groupId>
           <artifactId>mybatis-spring-boot-starter</artifactId>
           <version>2.1.4</version>
       </dependency>
       <dependency>
           <groupId>org.hibernate.validator</groupId>
           <artifactId>hibernate-validator</artifactId>
           <version>6.1.5.Final</version>
       </dependency>
       <!-- 添加数据库驱动、连接池 -->
       <dependency>
           <groupId>mysql</groupId>
           <artifactId>mysql-connector-java</artifactId>
           <version>8.0.20</version>
       </dependency>
       <dependency>
           <groupId>com.alibaba</groupId>
           <artifactId>druid</artifactId>
           <version>1.2.4</version>
       </dependency>
       <dependency>
           <groupId>junit</groupId>
           <artifactId>junit</artifactId>
           <version>4.11</version>
           <scope>test</scope>
       </dependency>
   </dependencies>
    <build>
       <resources>
           <!-- 注意这里要给springBoot指定需要打包的静态资源。否则SpringBoot将找不到配置文件 -->
           <resource>
               <directory>src/main/java</directory>
               <includes>
                   <include>**/*.yml</include>
                   <include>**/*.properties</include>
                   <include>**/*.xml</include>
               </includes>
               <filtering>false</filtering>
           </resource>
           <resource>
               <directory>src/main/resources</directory>
               <includes>
                   <include>**/*.yml</include>
                   <include>**/*.properties</include>
                   <include>**/*.xml</include>
               </includes>
               <filtering>false</filtering>
           </resource>
       </resources>
   </build>
</project>

添加application.properties文件

spring.datasource.driverClassName:com.mysql.jdbc.Driver
spring.datasource.url:jdbc:mysql://127.0.0.1:3307/flying_ping?useUnicode=true&characterEncoding=utf-8&useSSL=true&serverTimezone=UTC
spring.datasource.username:root
spring.datasource.password:root

编写POJO实体

package com.test.pojo;

import java.util.Date;

public class User {

    private Integer userId;
    private String userName;
    private String password;
    private Boolean isAutoLogin;
    private Boolean isRememberPassword;
    private Date lastLoginTime;

    public User(){
        super();
    }

    public User(Integer userId, String userName, String password, Boolean isAutoLogin, Boolean isRememberPassword, Date lastLoginTime) {
        this.userId = userId;
        this.userName = userName;
        this.password = password;
        this.isAutoLogin = isAutoLogin;
        this.isRememberPassword = isRememberPassword;
        this.lastLoginTime = lastLoginTime;
    }

    public Integer getUserId() {
        return userId;
    }

    public void setUserId(Integer userId) {
        this.userId = userId;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public Boolean getAutoLogin() {
        return isAutoLogin;
    }

    public void setAutoLogin(Boolean autoLogin) {
        isAutoLogin = autoLogin;
    }

    public Boolean getRememberPassword() {
        return isRememberPassword;
    }

    public void setRememberPassword(Boolean rememberPassword) {
        isRememberPassword = rememberPassword;
    }

    public Date getLastLoginTime() {
        return lastLoginTime;
    }

    public void setLastLoginTime(Date lastLoginTime) {
        this.lastLoginTime = lastLoginTime;
    }

    @Override
    public String toString() {
        return "User{" +
                "userId=" + userId +
                ", userName='" + userName + '\'' +
                ", password='" + password + '\'' +
                ", isAutoLogin=" + isAutoLogin +
                ", isRememberPassword=" + isRememberPassword +
                ", lastLoginTime=" + lastLoginTime +
                '}';
    }
}

实体对应表的SQL脚本如下：

CREATE TABLE `gg_user` (
  `user_id` int(11) NOT NULL AUTO_INCREMENT,
  `user_name` varchar(15) DEFAULT NULL COMMENT '账号',
  `password` varchar(500) DEFAULT NULL,
  `is_auto_login` bit(1) DEFAULT NULL COMMENT '是否自动登录',
  `is_remember_password` bit(1) DEFAULT NULL COMMENT '是否记住密码',
  `last_login_time` datetime DEFAULT NULL COMMENT '最后登录时间',
  PRIMARY KEY (`user_id`)
)

编写Mapper.xml映射文件（UsersMapper.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.test.mapper.UsersMapper">
   <insert id="add" parameterType="User">
       INSERT INTO gg_user (user_name,password,is_auto_login,is_remember_password,last_login_time) VALUES (#{userName,jdbcType=VARCHAR},#{password,jdbcType=VARCHAR},
       #{isAutoLogin,jdbcType=BIT},#{isRememberPassword,jdbcType=BIT},#{lastLoginTime,jdbcType=DATE})
   </insert>

   <select id="findOne" parameterType="Integer" resultType="User">
       SELECT * FROM gg_user WHERE user_id = #{id,jdbcType=INTEGER}
   </select>
   <update id="update" parameterType="User">
       UPDATE gg_user SET user_name = #{userName,jdbcType=VARCHAR} WHERE user_id=#{id,jdbcType=INTEGER}
   </update>
   <delete id="delete" parameterType="Integer">
       DELETE FROM gg_user WHERE user_id = #{id,jdbcType=INTEGER}
   </delete>
</mapper>

编写Mapper接口

package com.test.mapper;

import com.test.pojo.User;

public interface UsersMapper {

   public void add(User user);

   public User findOne(Integer id);

   public void update(String userName,Integer id);

   public void delete(Integer id);
}

在application.properties文件中配置映射文件

# 映射文件位置
mybatis.mapper-locations:com/test/mapper/UsersMapper.xml
# 使用别名的包，作用同mapper.xml中的<ResultMap>节点
mybatis.type-aliases-package:com.test.pojo
# 开启驼峰式命名规则
mybatis.configuration.map-underscore-to-camel-case=true

编写Controller

package com.test.controller;

import com.test.mapper.UsersMapper;
import com.test.pojo.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

import java.util.HashMap;
import java.util.Map;

@RestController
@RequestMapping("user")
public class UserController {

  @Autowired
  private UsersMapper mapper;

  @RequestMapping("add")
  public Map<Integer,String> add(){
      Map<Integer, String> result = new HashMap<>();
      User user = new User();
      user.setUserName("lisi");
      user.setPassword("123456");
      user.setRememberPassword(true);
      user.setAutoLogin(false);
      try {
          mapper.add(user);
          result.put(200,"添加成功");
      } catch (Exception e) {
          e.printStackTrace();
          result.put(500,e.getMessage());
      }
      return result;
  }

  @RequestMapping("getUserById")
  @ResponseBody
  public User getUserById(String id){
      User user = mapper.findOne(Integer.valueOf(id));
      return user;
  }

  @RequestMapping("updateUserName")
  @ResponseBody
  public Map<Integer,String> updateUserName(String userName,Integer id){
      Map<Integer, String> result = new HashMap<>();
      try {
          mapper.update(userName,id);
          result.put(200,"修改成功");
      } catch (Exception e) {
          e.printStackTrace();
          result.put(500,e.getMessage());
      }
      return result;
  }

  @RequestMapping("deleteById")
  @ResponseBody
  public Map<Integer,String> deleteById(Integer id){
      Map<Integer, String> result = new HashMap<>();
      try {
          mapper.delete(id);
          result.put(200,"删除成功");
      } catch (Exception e) {
          e.printStackTrace();
          result.put(500,e.getMessage());
      }
      return result;
  }

}

编写启动类

package com.test;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan("com.test.mapper")
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class,args);
    }
}

启动后添加数据
可以看懂操作成功了！！！其他的查询、修改、删除都一样了，我就不一个一个的做展示了。
下面我来说一下关于application.properties里面的key值，这个是怎么定义的

2、SpringBoot中*.properties文件和*.yml文件中的key值

关于SpringBoot的properties中的Key值定义，SpringBoot中提供了很多，我就不用全都列举了，我先举两个例子，完了我会把这个技巧分享在下面

上面在整合Mybatis和MySQL时，配置如下

spring.datasource.driverClassName:com.mysql.jdbc.Driver
spring.datasource.url:jdbc:mysql://127.0.0.1:3307/flying_ping?useUnicode=true&characterEncoding=utf-8&useSSL=true&serverTimezone=UTC
spring.datasource.username:root
spring.datasource.password:root

# 映射文件位置
mybatis.mapper-locations:com/test/mapper/UsersMapper.xml
# 使用别名的包，作用同mapper.xml中的<ResultMap>节点
mybatis.type-aliases-package:com.test.pojo
# 开启驼峰式命名规则
mybatis.configuration.map-underscore-to-camel-case=true

按住Ctrl键点击Key之后，进入了SpringBoot对应的自动装配类

@ConfigurationProperties(
    prefix = "mybatis"
)
public class MybatisProperties {
    public static final String MYBATIS_PREFIX = "mybatis";
    private static final ResourcePatternResolver resourceResolver = new PathMatchingResourcePatternResolver();
    private String configLocation;
    private String[] mapperLocations;
    private String typeAliasesPackage;
    private Class<?> typeAliasesSuperType;
    private String typeHandlersPackage;
    private boolean checkConfigLocation = false;
    private ExecutorType executorType;
    private Class<? extends LanguageDriver> defaultScriptingLanguageDriver;
    private Properties configurationProperties;
    @NestedConfigurationProperty
    private Configuration configuration;

这里我们可以清晰地看到SpirngBoot提供的Mybatis需要的配置参数名，用法就是驼峰式的属性名称转成“-”分割的key值就可以了，并且所有的配置都可以在SpringBoot的*.spring.boot.autoconfigure下找到
如图：

properties中配置信息的Key值命名规则

在SpringBoot的*.spring.boot.autoconfigure下找到需要配置参数的类；
key = prefix中的值+"."+驼峰式的属性名称转成“-”分割后的值