SpringBoot整合mybatis,需要做什么工作呢?
1、添加maven包依赖;
2、设置数据库连接参数,连接池;
3、创建model、dao、mapper;
4、告诉springboot,model、dao、mapper的位置;
5、启动项目测试。
下面按照这个步骤解释每一步操作:
一、添加maven包依赖。一共需要添加3个maven依赖,分别是
1、mybatis-springboot整合包:mybatis-spring-boot-starter;
2、数据库连接驱动包,我使用的是mysql: mysql-connector-java;
3、数据库连接池,我使用的是阿里巴巴的数据源:alibaba-druid;
相应的pom.xml内容如下:
<!-- mybatis -->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.0</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.0.29</version>
</dependency>
二、设置数据库连接信息。这里就没有像原来的spring需要配置sqlSession和SessionFactory那么麻烦,只需要在application.properties中设置好一些连接信息就可以了。
在application.properties中增加以下信息:
#mysql-setting
spring.datasource.url=jdbc\:mysql\://localhost\:3306/my_db
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
spring.datasource.initialSize=5
spring.datasource.minIdle=5
spring.datasource.maxActive=20
关于以上配置内容,相信有java数据库开发经验的都比较熟悉,主要是配置了数据库连接url、用户名、密码、数去库连接驱动、数据源(即连接池)以及一些连接属性。SpringBoot自动根据这些信息配置好dataSource、sqlSession等信息。
假如你做了第一步添加了maven依赖,而没有第二步数据库连接信息,启动项目时会报错没有数据源的设置。因此可以推测你只要添加了mybatis-spring-boot-starter的maven依赖,SpringBoot就会强制来读这些配置文件并设置好数据源。
三、创建model、dao、mapper。有些人喜欢把sql写在dao的接口上面,有些人喜欢写在xml文件中。作为不喜欢重复写一些基本sql的我,我喜欢直接用软件或一个项目直接生成dao、model、mapper,省去一些简单sql的编写。
在此我推荐一个本人修改别人代码编写的一个软件,点击下载:model dao mapper自动生成
Demo.java
package com.lan.BootMybatis.model;
import java.util.Date;
public class Demo {
private Integer id;
private String name;
private Integer value;
private Date createTime;
// get set 方法略
}
DemoMapper.java
package com.lan.BootMybatis.mapper;
import java.util.List;
import com.lan.BootMybatis.model.Demo;
public interface DemoMapper {
List<Demo> findAll();
}
DemoMapper.xml,我是在resources下创建文件夹mybatis/mapper用于存放mapper.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.lan.BootMybatis.mapper.DemoMapper" >
<resultMap id="BaseResultMap" type="com.lan.BootMybatis.model.Demo" >
<id column="id" property="id" jdbcType="INTEGER" />
<result column="name" property="name" jdbcType="VARCHAR" />
<result column="value" property="value" jdbcType="INTEGER" />
<result column="create_time" property="createTime" jdbcType="TIMESTAMP" />
</resultMap>
<sql id="Base_Column_List" >
id, name, value, create_time
</sql>
<!-- *************************************************************************************************** -->
<select id="findAll" resultMap="BaseResultMap">
select <include refid="Base_Column_List"/>
from t_demo
</select>
</mapper>
附带对应的数据库表结构的建表语句:
CREATE TABLE `t_demo` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`name` varchar(255) DEFAULT NULL,
`value` int(11) DEFAULT NULL,
`create_time` datetime DEFAULT CURRENT_TIMESTAMP,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
四、告诉springboot,model、dao、mapper的位置。
1、告诉SpringBoot,model、和mapper的位置,直接在application.properties中添加这两行配置:
#mybatis
mybatis.type-aliases-package=com.lan.BootMybatis.model #model所在的包
mybatis.mapper-locations=classpath:mybatis/mapper/*.xml #mapper.xml所在的位置
2、告诉SpringBoot,dao文件位置。这里有2中方法,一种是在每个dao的java类上加上@Mapper注解,另一种是在启动类中加上@MapperScan注解。
方法1:
@Mapper
public interface DemoMapper {
List<Demo> findAll();
}
方法2:
package com.lan.BootMybatis;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
@MapperScan("com.lan.BootMybatis.mapper")
public class BootMybatisApplication {
public static void main(String[] args) {
SpringApplication.run(BootMybatisApplication.class, args);
}
}
五、到此写一个测试controller去读数据库,测试是否ok;
package com.lan.BootMybatis.controller;
import java.util.List;
import javax.annotation.Resource;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import com.lan.BootMybatis.mapper.DemoMapper;
import com.lan.BootMybatis.model.Demo;
@RestController
public class TestController {
@Resource
private DemoMapper demoMapper;
@RequestMapping("findAll")
public List<Demo> findAll(){
return demoMapper.findAll();
}
}
运行Application.java的main方法,向数据库中添加几条数据,然后访问:
结果如下:
到此已说明mybatis配置成功,不过还没有配置事务等功能。
此外假如pom文件报错,这里附上解决了报错的完整pom.xml文件
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>
<groupId>com.lan</groupId>
<artifactId>SpringBoot</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>SpringBoot</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.5.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!-- springmvc -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- mybatis -->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.0</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.0.29</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<fork>true</fork>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
<skipTests>true</skipTests> <!--默认关掉单元测试 -->
<forkMode>once</forkMode>
<argLine>-Dfile.encoding=UTF-8</argLine>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>1.8</source>
<target>1.8</target>
<encoding>UTF-8</encoding>
<skipTests>true</skipTests><!-- 跳过测试 -->
<verbose>true</verbose>
<fork>true</fork><!-- 要使compilerVersion标签生效,还需要将fork设为true,用于明确表示编译版本配置的可用 -->
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<configuration>
<encoding>UTF-8</encoding>
</configuration>
</plugin>
</plugins>
</build>
</project>
最终项目结构:
如需要下载项目,可查看github: https://github.com/heesonlan/SpringBoot-Mybatis
author:蓝何忠
email:lanhezhong@163.com