SpringBoot 整合jdbc和mybatis的方法

通用配置#

下面介绍的整合JDBC和整合MyBatis都需要添加的实体类和配置

数据库表#

CREATE TABLE `user` (
 `id` int(11) NOT NULL AUTO_INCREMENT,
 `username` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NOT NULL,
 `address` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NOT NULL,
 PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 4 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_0900_ai_ci ROW_FORMAT = Dynamic;

SET FOREIGN_KEY_CHECKS = 1;

实体类#

添加简单的User实体类，用于下面jdbc和mybatis的使用和测试。再添加一个toString方法为了测试时看结果比较简单。

public class User {
 private Integer id;
 private String username;
 private String address;
 public Integer getId() { return id; }
 public void setId(Integer id) { this.id = id; }
 public String getUsername() { return username; }
 public void setUsername(String username) { this.username = username; }
 public String getAddress() { return address; }
 public void setAddress(String address) { this.address = address; }
 @Override
 public String toString() {
  return "User{" +
    "id=" + id +
    ", username='" + username + '\'' +
    ", address='" + address + '\'' +
    '}';
 }
}

maven配置#

mysql版本根据自己数据库版本设置

druid为阿里云提供的数据源（可理解为连接池）

<dependency>
 <groupId>com.alibaba</groupId>
 <artifactId>druid-spring-boot-starter</artifactId>
 <version>1.1.10</version>
</dependency>
<dependency>
 <groupId>mysql</groupId>
 <artifactId>mysql-connector-java</artifactId>
 <scope>runtime</scope>
 <version>8.0.18</version>
</dependency>

数据库配置#

数据库properties配置肯定是少不的啦.

spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
spring.datasource.username=username
spring.datasource.password=password
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/mydatabase

整合JDBC#

maven依赖#

添加springboot提供的jdbc依赖

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-data-jdbc</artifactId>
</dependency>

使用#

@Service
public class UserService {

 @Autowired
 JdbcTemplate jdbcTemplate;

 public Integer addUser(User user) {
  return jdbcTemplate.update("insert into user (username,address) values (?,?);",
    user.getUsername(), user.getAddress());
 }

 /**
  * 查询方式一
  * 当类属性和数据库字段不对应时才这样使用
  * @return
  */
 public List<User> getAllUserFirst() {
  return jdbcTemplate.query("select * from user;", new RowMapper<User>() {
   @Override
   public User mapRow(ResultSet resultSet, int i) throws SQLException {
    User user = new User();
    int id = resultSet.getInt("id");
    String address = resultSet.getString("address");
    String username = resultSet.getString("username");
    user.setId(id);
    user.setUsername(username);
    user.setAddress(address);
    return user;
   }
  });
 }

 /**
  * 查询方式二
  * 当类属性和数据库字段对应时就这样使用啦，比上面的简洁很多
  */
 public List<User> getAllUserSecond() {
  return jdbcTemplate.query("select * from user;", new BeanPropertyRowMapper<>(User.class));
 }
}

这里需要记一下，jdbc不论新增，修改，删除都是使用update方法。而查询则是使用query。

如果数据库字段和实体类属性不一致时，则需要使用上面代码中的查询方式一

如果数据库字段和实体类属性全都一致时，则可以使用上面代码中的查询方式二，简单快捷。

测试#

整理完后当然是少补了测试的啦，测试类如下：

@SpringBootTest
class JdbcApplicationTests {

 @Autowired
 UserService userService;

 @Test
 public void addUser() {
  User user = new User();
  user.setUsername("johnson2");
  user.setAddress("colablog.cn");
  userService.addUser(user);
 }

 public void queryUsers() {
  List<User> allUserFirst = userService.getAllUserFirst();
  System.out.println(allUserFirst);
 }
}

整合MyBatis#

当下最流行的持久层框架MyBatis，天天SSM，听到耳朵都起茧子了。整合MyBatis可能是使用到最多的，整合如下：

maven依赖#

版本的话可以查看maven仓库

<dependency>
 <groupId>org.mybatis.spring.boot</groupId>
 <artifactId>mybatis-spring-boot-starter</artifactId>
 <version>2.1.1</version>
</dependency>

扫描Mapper#

需要提供mapper路径给SpringBoot进行扫描,我的包扫描路径为cn.colablog.mybatis.mapper

方式一：自己添加一个配置项

@Configuration
@MapperScan(basePackages = "cn.colablog.mybatis.mapper")
public class MyBatisConfig {
}

方式二：直接在Application上配置

@SpringBootApplication
@MapperScan(basePackages = "cn.colablog.mybatis.mapper")
public class MybatisApplication {
 public static void main(String[] args) {
  SpringApplication.run(MybatisApplication.class, args);
 }
}

Mapper映射#

UserMapper接口#

在Mapper包cn.colablog.mybatis.mapper目录下添加UserMapper接口

@Mapper
public interface UserMapper {
 List<User> getAllUser();
}
UserMapper.xml#
Copy
<?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.colablog.mybatis.mapper.UserMapper">
 <select id="getAllUser" resultType="com.colablog.mybatis.bean.User">
  select * from user
 </select>
</mapper>

存放方式有三种:

方式一（默认）

SpringBoot默认找Mapper.xml是在resources目录下，例如映射User类的路径在java目录下的cn.colablog.mybatis.mapper。

那么UserMapper.xml就需要放在resources目录下的cn.colablog.mybatis.mapper.

注意：如果你使用的是IDEA开发工具,resource下添加目录不能这样添加：

这样添加IDEA只会帮你添加一个名为cn.colablog.mybatis.mapper的目录，所以你需要逐个目录依次添加，存放位置如下：

方式二

在properties文件中进行配置存放路径：

mybatis.mapper-locations=classpath:/mapper/*.xml

存放位置如下：

方式三

在pom.xml中配置resource需要加载java目录下的xml文件：

 <build>
  <resources>
   <resource>
    <directory>src/main/java</directory>
    <includes>
     <include>**/*.xml</include>
    </includes>
   </resource>
   <resource>
    <directory>src/main/resources</directory>
   </resource>
  </resources>
  ...
 </build>

这样你可以和UserMapper接口存放在同一个目录下，存放位置如下：