Springboot之与Mybatis整合-yellowcong

柔情只为你懂 2022-05-28 02:44 179阅读 0赞

> Springboot和Mybatis搞基，有以下几个步骤：1、添加数据库，日志，mybatis的依赖包；2、配置application.properties 设定mapper文件目录，entity目录；3、配置启动类，设置Dao所在的目录；4、配置log4j2.xml，设定日志的输出规则；5、测试mybatis是否配置成功。

## 代码地址 ##

https://gitee.com/yellowcong/springboot-demo/tree/master/springboot-mybatis

### 目录结构 ###

![这里写图片描述][SouthEast]

## Mybatis整合 ##

### 1、导入依赖包 ###

需要导入mybatis的包，同时我们需要导入日志和阿里的数据连接池的包，也可以是dbcp等连接池。

<dependency>
 <groupId>mysql</groupId>
 <artifactId>mysql-connector-java</artifactId>
 </dependency>
 
 
 <dependency>
 <groupId>org.mybatis.spring.boot</groupId>
 <artifactId>mybatis-spring-boot-starter</artifactId>
 <version>1.3.1</version>
 </dependency>
 
 
 <dependency>
 <groupId>log4j</groupId>
 <artifactId>log4j</artifactId>
 <version>${log4j.version}</version>
 </dependency>
 
 
 <dependency>
 <groupId>com.alibaba</groupId>
 <artifactId>druid</artifactId>
 <version>1.1.0</version>
 </dependency>

### 2、配置application.properties ###

配置数据库连接以及连接池，我这个地方数据库连接，后面带的一堆参数中，主要有设定编码，允许一次插入多条。注意`mybatis.typeAliasesPackage=com.yellowcong.entity`和`mybatis.mapperLocations=classpath:mapper/*.xml`,这两个指定了实体类的位置和xml配置文件位置。

#日志地址
    logging.file=logs/config/demo-xx.log
    info.name=入门案例‹
    #配置日志信息
    logging.config=classpath:log4j2.xml
    
    #端口号
    server.port=80
    #访问路径
    server.context-path=/
    
    ##############################################
    #配置Thymeleaf 
    #thymeleaf start
    spring.thymeleaf.mode=LEGACYHTML5
    spring.thymeleaf.encoding=UTF-8
    spring.thymeleaf.content-type=text/html
    #开发时关闭缓存,不然没法看到实时页面
    spring.thymeleaf.cache=false
    # 在构建URL时预先查看名称的前缀 （默认就是这个）
    spring.thymeleaf.prefix=classpath:/templates/
    # 构建URL时附加查看名称的后缀.（默认就是 html的结尾的）
    spring.thymeleaf.suffix=.html
    #thymeleaf end
    
    
    ##############################################
    #配置mybatis的xml 和实体类存放目录
    #实体类所在的包
    mybatis.typeAliasesPackage=com.yellowcong.entity
    #mapper文件所在的包
    mybatis.mapperLocations=classpath:mapper/*.xml #设定日志的等级,用来显示mysql日志 logging.level.com.alibaba.*=info #连接诶数据库 spring.datasource.url=jdbc:mysql://127.0.0.1:3306/yellowcong?useUnicode=true&characterEncoding=UTF-8&&allowMultiQueries=true&zeroDateTimeBehavior=convertToNull #用户名 spring.datasource.username=root #密码 spring.datasource.password=root #驱动类 spring.datasource.driver-class-name=com.mysql.jdbc.Driver #数据连接池类型 spring.datasource.type=com.alibaba.druid.pool.DruidDataSource ##############################################

### 3、配置启动类，设置dao位置 ###

添加注解`@MapperScan("com.yellowcong.dao")`到启动类上，这样Springboot才会识别到我们的Mybatis的dao

package com.yellowcong;
    
    import org.mybatis.spring.annotation.MapperScan;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.boot.context.embedded.ConfigurableEmbeddedServletContainer;
    import org.springframework.boot.context.embedded.EmbeddedServletContainerCustomizer;
    import org.springframework.boot.web.servlet.ErrorPage;
    import org.springframework.context.annotation.Bean;
    import org.springframework.http.HttpStatus;
    import org.springframework.http.converter.HttpMessageNotReadableException;
    
    @SpringBootApplication
    @EnableAutoConfiguration
    //配置DAO的包位置
    @MapperScan("com.yellowcong.dao")
    public class ConfigMain {
    
        public static void main(String[] args) {
            SpringApplication.run(ConfigMain.class, args);
        }
    }

### 4、配置日志 ###

这个日志，主要是让mybatis的日志打印出来，让我们好排错的，日志文件log4j2.xml放在`src/main/resources/`目录下。

<?xml version="1.0" encoding="UTF-8" ?>
 <configuration>
 
 <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
 <encoder>
 <pattern>[%d{yyyy-MM-dd HH:mm:ss:SSS}] %p (%file:%line\) - %m%n</pattern>
 <charset>UTF-8</charset>
 </encoder>
 </appender> 
 
 <appender name="baselog" class="ch.qos.logback.core.rolling.RollingFileAppender">
 
 
 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
 <fileNamePattern>log/yellowcong-%d{yyyy-MM-dd}.log</fileNamePattern>
 </rollingPolicy>
 <encoder>
 <pattern>
 [%d{yyyy-MM-dd HH:mm:ss:SSS}] %p (%file:%line\) - %m%n
 </pattern>
 <charset>UTF-8</charset>
 
 </encoder>
 </appender>
 
 <appender name="Mybatislog" class="ch.qos.logback.core.rolling.RollingFileAppender">
 
 
 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
 <fileNamePattern>log/yellowcong-myabtis-%d{yyyy-MM-dd}.log</fileNamePattern>
 </rollingPolicy>
 <encoder>
 <pattern>
 [%d{yyyy-MM-dd HH:mm:ss:SSS}] %p (%file:%line\) - %m%n
 </pattern>
 <charset>UTF-8</charset>
 
 </encoder>
 </appender>
 <root level="info">
 <appender-ref ref="STDOUT"/>
 </root>
 
 <logger name="com.yellowcong.dao" level="DEBUG">
 <appender-ref ref="Mybatislog"/>
 </logger>
 
 <logger name="com.yellowcong" level="DEBUG">
 <appender-ref ref="baselog"/>
 </logger>
 </configuration>

## 创建测试 ##

### 1、数据库和表创建 ###

CREATE DATABASE /*!32312 IF NOT EXISTS*/`yellowcong` /*!40100 DEFAULT CHARACTER SET utf8 COLLATE utf8_bin */;
    
    USE `yellowcong`;
    
    /*Table structure for table `sys_user` */
    
    DROP TABLE IF EXISTS `sys_user`;
    
    CREATE TABLE `sys_user` ( `username` varchar(64) COLLATE utf8_bin NOT NULL COMMENT '用户名', `password` varchar(64) COLLATE utf8_bin DEFAULT NULL COMMENT '密码', PRIMARY KEY (`username`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin;

### 2、创建实体类 ###

package com.yellowcong.entity;
 
 import java.io.Serializable;
 
 /** * 创建日期:2018年4月7日 * 代码创建:黄聪 * 功能描述:用户实体类 */
 public class UserEntity implements Serializable { 
 /** * 用户名 */
 private String username;
 
 /** * 密码 */
 private String password;
 
 private static final long serialVersionUID = 1L;
 
 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;
 }
 }

### 3、创建Dao ###

这个dao中，就两个方法，一个是获取全部的用户，另一个是插入用户。

package com.yellowcong.dao;
 
 import java.util.List;
 
 import com.yellowcong.entity.UserEntity;
 
 public interface UserDao { 
 
 /** * 创建日期:2018年4月7日 * 代码创建:黄聪 * 功能描述:插入数据 * @param record * @return */
 int insert(UserEntity record);
 
 /** * 创建日期:2018年4月7日 * 代码创建:黄聪 * 功能描述:获取所有的用户信息 * @return */
 List<UserEntity> getAll();
 }

### 4、创建对应的mapper ###

<?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.yellowcong.dao.UserDao">
 <resultMap id="BaseResultMap" type="com.yellowcong.entity.UserEntity">
 <id column="username" jdbcType="VARCHAR" property="username" />
 <result column="password" jdbcType="VARCHAR" property="password" />
 </resultMap>
 <sql id="Base_Column_List">
 username, password
 </sql>
 <insert id="insert" parameterType="com.yellowcong.entity.UserEntity">
 insert into sys_user (username, password)
 values (#{username,jdbcType=VARCHAR}, #{password,jdbcType=VARCHAR})
 </insert>
 
 <select id="getAll" resultMap="BaseResultMap">
 select 
 <include refid="Base_Column_List" />
 from sys_user
 </select>
 </mapper>

### 5、添加测试类 ###

package com.yellowcong.dao;
 
 import javax.annotation.Resource;
 
 import org.junit.Assert;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.test.context.junit4.SpringRunner;
 
 import com.yellowcong.ConfigMain;
 import com.yellowcong.entity.UserEntity;
 
 /** * 创建日期:2018年4月7日 * 代码创建:黄聪 * 功能描述: */
 @RunWith(SpringRunner.class)
 //这个地方需要配置自己的启动类
 @SpringBootTest(classes = ConfigMain.class, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
 //开启自动注解
 @EnableAutoConfiguration
 public class UserDaoTest {
 
 @Autowired
 private UserDao userDao;
 
 @Test
 public void testAdd(){
 UserEntity entity = new UserEntity();
 entity.setPassword("test");
 entity.setUsername("test");
 //返回值 为 插入的条数
 int rt = userDao.insert(entity);
 //判断是否插入
 Assert.assertTrue(rt > 0);
 }
 }

### 6、测试结果 ###

测试中，我表中本来没有任何数据的，执行测试后，表中多了一条数据，插入成功。  
![这里写图片描述][SouthEast 1]

## 参考文章 ##

[https://www.cnblogs.com/peterxiao/p/7779188.html][https_www.cnblogs.com_peterxiao_p_7779188.html]  
[https://blog.csdn.net/long270022471/article/details/59482556][https_blog.csdn.net_long270022471_article_details_59482556]

[SouthEast]: /images/20220528/f3c61e6a395a4ff997272f595ccf83df.png
[SouthEast 1]: /images/20220528/cffcb8d871e942e0af8f78d3bbe09b82.png
[https_www.cnblogs.com_peterxiao_p_7779188.html]: https://www.cnblogs.com/peterxiao/p/7779188.html
[https_blog.csdn.net_long270022471_article_details_59482556]: https://blog.csdn.net/long270022471/article/details/59482556