随笔- 261 文章- 0 评论- 12 阅读- 45万

Springboot 2.x 整合 Mybatis

一、创建工程

MySQL Driver 的作用是帮我们注册驱动,之前做 JDBC 整合的时候导入 JDBC API,它的作用是会帮我们配置数据源,但是我们这里却没有选择 JDBC API 模块,难道是不需要配置数据源吗,其实不是的,我们选择 MyBatis Framework 模块,它会帮我们将 JDBC 也一起导入进来

引入的依赖如下:

<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>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>
// 数据源使用 Druid ,不再使用 Springboot 默认的数据源
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.2.3</version>
</dependency>

创建完成之后注意,我们发现 MyBatis 依赖的命名和其他库的命名不太一样,其它的依赖都是以 spring-xx 开头的,而它是以 mybatis 开头的,是的,这个整合 jar 包并不是 springboot 自己的,这表示该 starter 是由第三方提供的,就像 Druid 数据源一样,也是第三方的.

二、项目结构

1、实体类(User)

// 实体类,省略 set / get 方法
public class User {
    private Integer id;
    private String username;
    private String password;
    private String gender;
    private Date birthday;
}   

2、Mapper 接口(UserMapper)

// 运行时生成对应的接口实现类
@Mapper
// 将该组件加入到 Spring 容器中
@Repository
public interface UserMapper {
 
    public abstract Integer insertUser(User user);
 
    public abstract List<User> selectAll();
}

这里要注意一下 @Mapper注解, @Mapper 注解添加位置在接口类上面它的作用是在运行时会生成相应的接口实现类,这种方法也是官方推荐使用的！这里只是测试整合 mybatis 编写一个 Mapper 接口即可，如果有需求要很多接口都要变成实现类,那么需要在每个接口类上加上 @Mapper 注解,比较麻烦,要解决这个问题可以使用 @MapperScan 注解.简单点说 @MapperScan 注解就是指定要扫描哪些包下的 Mapper 接口

// com.springboot.mybatis.mapper 包下的所有接口都在运行时可以生成实现类
@MapperScan("com.springboot.mybatis.mapper")
@SpringBootApplication
public class MybatisApplication {
    public static void main(String[] args) {
        SpringApplication.run(MybatisApplication.class, args);
    }
}

3、application.properties

########################### 数据库属性 ###########################
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.url=jdbc:mysql://192.168.229.131:3308/mybatis
spring.datasource.driverClassName=com.mysql.cj.jdbc.Driver
 
########################### Druid 数据源配置 ###########################
# 配置当前要使用的数据源的操作类型,如果不配置就使用 springboot 默认的数据源
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
# 进行数据库链接池的配置，数据库最小维持连接数
spring.datasource.dbcp2.min-idle=1
# 数据库初始化提供的连接数
spring.datasource.dbcp2.initial-size=1
# 数据库最大维持连接数
spring.datasource.dbcp2.max-total=1
 
########################### MyBatis 配置文件 ###########################
# 指定全局配置文件的位置
mybatis.config-location=classpath:mybatis-config/mybatis-global.xml
# 指定 sql 映射文件的位置
mybatis.mapper-locations=classpath:mybatis-config/mapper/*.xml
# com.springboot.mybatis.entity 包下的所有实体类都开启别名,当然也可以在 mybatis 的全局配置文件中开启
# mybatis.type-aliases-package=com.springboot.mybatis.entity

4、mybatis 全局配置文件(mybatis-global.xml)

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <settings>
        <!--开启驼峰命名规则-->
        <setting name="mapUnderscoreToCamelCase" value="true"/>
    </settings>
    <typeAliases>
        <!-- com.mybatis.entity 包下的所有实体类都开启别名-->
        <package name="com.springboot.mybatis.entity"></package>
    </typeAliases>
</configuration>

5、Mapper 映射文件(UserMapper.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.springboot.mybatis.mapper.UserMapper">
    <insert id="insertUser" useGeneratedKeys="true" keyProperty="id">
        INSERT INTO user VALUES (null,#{username},#{password},#{gender},#{birthday})
    </insert>
 
    <select id="selectAll" resultType="User">
        SELECT * FROM user
    </select>
</mapper>

6、DruidConfig.java (使用 Druid 作为数据源,废弃 Springboot 默认的数据源,并对 SQL 进行监控)

@Configuration
public class DruidConfig {
    @Bean
    // 与 spring 的配置文件 application.properties 中前缀为 spring.datasource 的标签进行属性绑定
    @ConfigurationProperties(prefix = "spring.datasource")
    public DruidDataSource druidDataSource() {
        return new DruidDataSource();
    }
 
    // 配置 Druid 的监控
    // 1、配置一个管理后台的 Servlet
    @Bean
    public ServletRegistrationBean statViewServlet() {
        ServletRegistrationBean bean = new ServletRegistrationBean(
                new StatViewServlet(), "/druid/*");
        Map<String, String> initParams = new HashMap<>();
        initParams.put("loginUsername", "admin");
        initParams.put("loginPassword", "123456");
        initParams.put("allow", "");
        //默认就是允许所有访问
        initParams.put("deny", "192.168.15.21");
        bean.setInitParameters(initParams);
        return bean;
    }
 
    //2、配置一个 web 监控的 filter
    @Bean
    public FilterRegistrationBean webStatFilter() {
        FilterRegistrationBean bean = new FilterRegistrationBean();
        bean.setFilter(new WebStatFilter());
        Map<String, String> initParams = new HashMap<>();
        initParams.put("exclusions", "*.js,*.css,/druid/*");
        bean.setInitParameters(initParams);
        bean.setUrlPatterns(Arrays.asList("/*"));
        return bean;
    }
}

三、测试类

@RestController
public class HelloController {
    @Autowired
    private UserMapper userMapper;
 
    @GetMapping("/mybatis/insert")
    public String insert(Integer id) {
        User user = new User();
        user.setUsername("xiaomaomao");
        user.setPassword("xiaomaomao123");
        user.setGender("female");
        user.setBirthday(new Date());
        Integer insertId = userMapper.insertUser(user);
        System.out.println(user.getId());
        return insertId.toString();
    }
 
    @GetMapping("/mybatis/selectAll")
    public String select() {
        List<User> userList = userMapper.selectAll();
        return userList.toString();
    }
}