SpringBoot 整合MyBatis--支持注解版和xml配置文件配置

喜欢ヅ旅行 2022-04-10 12:59 291阅读 0赞

> **如果我的博客能够帮到大家能够点个赞，关注一下，以后还会更新更过JavaWeb的高级技术，大家的支持就是我继续更新的动力。谢谢。**

>         我前边的博客，写了有关于Spring和mybaitis、jpa、springData 的整合等，今天呢，使用SpringBoot和Mybatis 整合，支持2种方式的配置
> 
> 1.  mybatis 注解版
> 2.  xml配置方式
> 
>      接下来，我就将这俩种方式介绍给大家，仅供参考，如有错误，请大家多多指教。

## 一、搭建工程  ##

### 步骤： ###

1.  创建SpringBoot的工程
2.  导入依赖
3.  编写配置文件
4.  编写application.yml文件
5.  编写实体和Mapper接口
6.  编写Mybatis配置文件
7.  测试

### 1.创建SpringBoot工程工程，大家都会，略 ###

### 2.导入依赖：pom.xml ###

>     <?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>
>         <parent>
>             <groupId>org.springframework.boot</groupId>
>             <artifactId>spring-boot-starter-parent</artifactId>
>             <version>2.1.1.RELEASE</version>
>             <relativePath/> 
>         </parent>
>         <groupId>com.nyist</groupId>
>         <artifactId>spring-boot-06-mybatis</artifactId>
>         <version>0.0.1-SNAPSHOT</version>
>         <name>spring-boot-06-mybatis</name>
>         <description>Demo project for Spring Boot</description>
>     
>         <properties>
>             <java.version>1.8</java.version>
>         </properties>
>     
>         <dependencies>
>             
>             <dependency>
>                 <groupId>org.springframework.boot</groupId>
>                 <artifactId>spring-boot-starter-jdbc</artifactId>
>             </dependency>
>             <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>1.3.2</version>
>             </dependency>
>             
>             <dependency>
>                 <groupId>mysql</groupId>
>                 <artifactId>mysql-connector-java</artifactId>
>                 <scope>runtime</scope>
>             </dependency>
>             <dependency>
>                 <groupId>org.springframework.boot</groupId>
>                 <artifactId>spring-boot-starter-test</artifactId>
>                 <scope>test</scope>
>             </dependency>
>     
>             
>             <dependency>
>                 <groupId>com.alibaba</groupId>
>                 <artifactId>druid</artifactId>
>                 <version>1.1.12</version>
>             </dependency>
>         </dependencies>
>         <build>
>             <plugins>
>                 <plugin>
>                     <groupId>org.springframework.boot</groupId>
>                     <artifactId>spring-boot-maven-plugin</artifactId>
>                 </plugin>
>             </plugins>
>         </build>
>     </project>

## 3.编写配置文件 ##

MyBatisConfig.java

>     package com.nyist.springboot06mybatis.config;
>     
>     import org.apache.ibatis.session.Configuration;
>     import org.mybatis.spring.boot.autoconfigure.ConfigurationCustomizer;
>     import org.springframework.context.annotation.Bean;
>     
>     @org.springframework.context.annotation.Configuration
>     public class MyBatisConfig {
>         @Bean
>         public ConfigurationCustomizer configurationCustomizer(){
>             return new ConfigurationCustomizer() {
>                 @Override
>                 public void customize(Configuration configuration) {
>                     //开启 驼峰命名法  规则
>                     configuration.setMapUnderscoreToCamelCase(true);
>                 }
>             };
>         }
>     }

DruidConfig.java

>     package com.nyist.springboot06mybatis.config;
>     
>     import com.alibaba.druid.pool.DruidDataSource;
>     import com.alibaba.druid.support.http.StatViewServlet;
>     import com.alibaba.druid.support.http.WebStatFilter;
>     import org.springframework.boot.context.properties.ConfigurationProperties;
>     import org.springframework.boot.web.servlet.FilterRegistrationBean;
>     import org.springframework.boot.web.servlet.ServletRegistrationBean;
>     import org.springframework.context.annotation.Bean;
>     import org.springframework.context.annotation.Configuration;
>     
>     import javax.sql.DataSource;
>     import java.util.Arrays;
>     import java.util.HashMap;
>     import java.util.Map;
>     @Configuration
>     public class DruidConfig {
>     
>         //@ConfigurationProperties 是将 阿里巴巴druid 的数据源 配置的属性和 属性文件绑定在一起
>         @ConfigurationProperties(prefix = "spring.datasource")
>         @Bean
>         public DataSource druid(){
>             return new DruidDataSource();
>         }
>     
>         //配置 Druid 的监控
>         //1.配置一个管理后台的Servlet
>         @Bean
>         public ServletRegistrationBean statViewServlet(){
>             ServletRegistrationBean bean = new ServletRegistrationBean(new StatViewServlet(),"/druid/*");
>             Map<String,String> map = new HashMap<>();
>             map.put("loginUsername","admin");
>             map.put("loginPassword","123456");
>             map.put("allow","localhost");       //不写 或者为null 默认允许所有
>             map.put("deny","192.168.1.122");
>             bean.setInitParameters(map);
>             return  bean;
>         }
>     
>         //2.配置一个监控的Filter
>         @Bean
>         public FilterRegistrationBean webStatFilter(){
>             FilterRegistrationBean initParam = new FilterRegistrationBean();
>             initParam.setFilter(new WebStatFilter());
>             Map<String,String> map = new HashMap<>();
>             //初始化不拦截请求的参数
>             map.put("exclusions","*.css,*.png,*.jpg,*.js,/druid/*");
>             initParam.setInitParameters(map);
>             //监控所有的请求
>             initParam.setUrlPatterns(Arrays.asList("/*"));
>             return initParam;
>         }
>     }

### 4.编写application.yml ###

>     spring:
>       datasource:
>         username: root
>         password: root
>         url: jdbc:mysql://localhost:3306/springdata_jdbc?useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
>         type: com.alibaba.druid.pool.DruidDataSource
>         #druid 数据源配置
>         initialSize: 5
>         minIdle: 5
>         maxActive: 20
>         maxWait: 60000
>         timeBetweenEvictionRunsMillis: 60000
>         minEvictableIdleTimeMillis: 300000
>         validationQuery: SELECT 1 FROM DUAL
>         testWhileIdle: true
>         testOnBorrow: false
>         testOnReturn: false
>         poolPreparedStatements: true
>         #   配置监控统计拦截的filters，去掉后监控界面sql无法统计，'wall'用于防火墙
>         filters: stat,wall,logback-spring
>         maxPoolPreparedStatementPerConnectionSize: 20
>         useGlobalDataSourceStat: true
>         connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500
>         #运行数据源建表语句
>     #    schema:
>     #      - classpath:sql/department.sql
>     #      - classpath:sql/employee.sql
>     mybatis:
>       #指定  mybatis 全局配置文件
>       config-location: classpath:mybatis/mybatis-config.xml
>       #指定 mybatis 的mapper 文件所在位置
>       mapper-locations: classpath:mybatis/mapper/*.xml

### 5.编写实体和Mapper接口 ###

DepartmentMapper.xml

>     package com.nyist.springboot06mybatis.Mapper;
>     
>     import com.nyist.springboot06mybatis.Entity.Department;
>     import org.apache.ibatis.annotations.*;
>     
>     //注解方式 代理  配置文件xml
>     //@Mapper表明这是一个数据库的Mapper
>     public interface DepartmentMapper {
>     
>         @Select("select * from department where id = #{id}")
>         public Department getDeptById(Integer id);
>     
>         @Delete("delete from department where id = #{id}")
>         public Integer deleteDeptById(Integer id);
>         //@Option用来返回 生成的主键,指定主键的生成方式 是否为自增 true 那个主键 id
>         @Options(useGeneratedKeys = true,keyProperty = "id")
>         @Insert("insert into department(departmentName) values(#{departmentName})")
>         public Integer insertDept(Department department);
>     
>         @Update("update department set departmentName = #{departmentName} where id = #{id}")
>         public Integer updateDept(Department department);
>     }

EmployeeMapper.java

>     package com.nyist.springboot06mybatis.Mapper;
>     
>     
>     import com.nyist.springboot06mybatis.Entity.Employee;
>     
>     public interface EmployeeMapper {
>     
>         public Employee getEmpById(Integer id);
>     
>         void insertEmp(Employee employee);
>     }

### 6.编写MyBatis配置文件 ###

在resource 下创建一个mybatis 的包，在该包下创建mapper包，在Mappre包下放MyBatis的mapper配置文件，在mybatis下放mybatis-config.xml主配置文件。Employee使用的xml配置文件测试，所以只有Employee实体类有Mapper配置文件。

EmployeeMapper.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.nyist.springboot06mybatis.Mapper.EmployeeMapper">
>     
>         <select id="getEmpById" parameterType="java.lang.Integer" resultType="com.nyist.springboot06mybatis.Entity.Employee">
>           select * from employee where id = #{id}
>         </select>
>     
>         <insert id="insertEmp" parameterType="com.nyist.springboot06mybatis.Entity.Employee">
>             insert  into employee(lastName,gender,email,d_id) values(#{lastName},#{gender},#{email},#{dId})
>         </insert>
>     </mapper>

mybatis-config.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>
>     </configuration>

### 8.测试 ###

主程序：

>     package com.nyist.springboot06mybatis;
>     
>     import org.mybatis.spring.annotation.MapperScan;
>     import org.springframework.boot.SpringApplication;
>     import org.springframework.boot.autoconfigure.SpringBootApplication;
>     //如果在以后工程中有很多个mapper 在每个mapper上添加一个@Mapper 这种方式很麻烦,我们只需要使用@MapperScan(value="主包名")
>     //开启Mapper 扫面  扫面到的文件默认加上@Mapper 注解
>     //使用@MapperScan 开启批量扫描
>     @MapperScan(value = "com.nyist.springboot06mybatis.Mapper")
>     @SpringBootApplication
>     public class SpringBoot06MybatisApplication {
>     
>         public static void main(String[] args) {
>             SpringApplication.run(SpringBoot06MybatisApplication.class, args);
>         }
>     
>     }

**测试有俩种测试，以中测试注解版mybatis，另一种测试xml版mybatis。DepartmentMapper为注解版，Employee为xml配置方式。**

### 测试mybatis注解版本 ###

编写DeptController.java

>     package com.nyist.springboot06mybatis.controller;
>     
>     import com.nyist.springboot06mybatis.Entity.Department;
>     import com.nyist.springboot06mybatis.Mapper.DepartmentMapper;
>     import org.springframework.beans.factory.annotation.Autowired;
>     import org.springframework.web.bind.annotation.GetMapping;
>     import org.springframework.web.bind.annotation.PathVariable;
>     import org.springframework.web.bind.annotation.RestController;
>     
>     @RestController
>     public class DeptController {
>     
>         @Autowired
>         private DepartmentMapper departmentMapper;
>     
>         @GetMapping("/dept/{id}")
>         public Department getDepartment(@PathVariable("id") Integer id){
>             return departmentMapper.getDeptById(id);
>         }
>     
>         @GetMapping("/dept")
>         public Department insertDept(Department department){
>             departmentMapper.insertDept(department);
>             return department;
>         }
>     }

测试添加：

![20190107142737334.png][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2x2aGFvZ3Vhbmcw_size_16_color_FFFFFF_t_70][]![20190107142757518.png][]

### 测试mybatis xml 版本  ###

EmployeeController.java

>     package com.nyist.springboot06mybatis.controller;
>     
>     import com.nyist.springboot06mybatis.Entity.Employee;
>     import com.nyist.springboot06mybatis.Mapper.EmployeeMapper;
>     import org.springframework.beans.factory.annotation.Autowired;
>     import org.springframework.web.bind.annotation.GetMapping;
>     import org.springframework.web.bind.annotation.PathVariable;
>     import org.springframework.web.bind.annotation.RestController;
>     
>     @RestController
>     public class EmployeeController {
>     
>         @Autowired
>         private EmployeeMapper employeeMapper;
>     
>         @GetMapping("/emp/{id}")
>         public Employee getEmpById(@PathVariable("id") Integer id){
>             return employeeMapper.getEmpById(id);
>         }
>     
>         @GetMapping("/emp")
>         public Employee insertEmp(Employee employee){
>             System.out.println("***********"+employee);
>             employeeMapper.insertEmp(employee);
>             return employee;
>         }
>     }

测试结果：

![20190107143223654.png][]

![20190107143234351.png][]

![2019010714331377.png][]

### 9.资源下载：[下载][Link 1] ###

[20190107142737334.png]: /images/20220330/3d0e69f5439045c4950732055e22ffcf.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2x2aGFvZ3Vhbmcw_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20190107142748302.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2x2aGFvZ3Vhbmcw,size_16,color_FFFFFF,t_70
[20190107142757518.png]: /images/20220330/2eb605348667419d955d716c08ffd9de.png
[20190107143223654.png]: /images/20220330/32c5ef706e594058885b2ee0eaa304b3.png
[20190107143234351.png]: /images/20220330/8ce81c16277a4521bab517186224ca8a.png
[2019010714331377.png]: /images/20220330/c9b5aef07df54636b66d8bbeb399ac22.png
[Link 1]: https://download.csdn.net/download/lvhaoguang0/10901178