SpringBoot 整合jdbc和mybatis

摘要

該文章主要爲記錄如何在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

<?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接口存放在同一個目錄下，存放位置以下：