Spring同時集成JPA與Mybatis-有解無憂

@目錄

ORM
Spring ORM
Spring ORM 同時集成JPA與Mybatis
- 一、創建一個SpringBoot專案
- 二、建立用戶資訊登記表
- 三、Web應用專案集成mysql
- 四、添加Spring Data JPA和Mybatis依賴
- 五、添加資料表映射物體類
- 六、創建資料介面層
  - 6.1 宣告JPA介面
  - 6.2 宣告MyBatis介面
- 七、創建業務服務層
- 八、創建控制器
- 九、設計視圖模板
  - 9.1 設計一個用戶串列的視圖模板
  - 9.2 設計一個提交用戶資訊的表單模板
  - 9.3 設計一個用戶模糊查找頁面模板
- 十、運行應用
  - 10.1用戶串列
  - 10.2增加用戶
  - 10.3查找用戶

ORM

ORM的出現，使得關系型資料庫映射成了物件；簡單來說，有了ORM之后，JAVA程式員從面向JDBC編程轉化成面向JAVA物件編程，

在這里插入圖片描述

Spring ORM

Spring對ORM的解決方案主要體現在以下方面：
1. 統一的資源管理方式與例外管理：Spring使用各種ORM框架，資源管理及使用方式都是統一的；同時Spring會將各個ORM框架的例外轉譯到Spring例外體系下，
2. 統一的事務管理：Spring通過IoC和AOP技術，形成了事務管理抽象層，接管了各種ORM框架下的資料訪問的事務管理，
隨著版本的升級，Spring核心包中對ORM的各種解決方案也越來越精煉，本文我們重點將介紹同時集成Spring Data JPA和Mybatis兩個ORM框架，

Spring ORM 同時集成JPA與Mybatis

在同一個專案中一般只會單獨集成Spring Data JPA,或者單獨集成Mybatis，但兩者也可以混合使用（一般沒這個必要），本文為了更加深入探索Spring ，將通過一個DEMO應用兩者的并展示相似點與不同之處，

一、創建一個SpringBoot專案

在IntelliJ IDEA中創建新專案
通過地址https://start.spring.io/初始化專案；
指定專案通用資訊：
選擇專案依賴Starter：
生成的專案結構：

二、建立用戶資訊登記表

根據用戶資訊模型類，設計用戶資訊登錄表

DROP DATABASE IF EXISTS user_info;

CREATE DATABASE user_info
	DEFAULT CHARACTER SET utf8
	DEFAULT COLLATE utf8_general_ci;

use user_info;

SET NAMES utf8mb4;
SET FOREIGN_KEY_CHECKS = 0;

-- ----------------------------
-- Table structure for user
-- ----------------------------
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user`  (
  `id` bigint(20) NOT NULL AUTO_INCREMENT,
  `name` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
  `email` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Dynamic;

SET FOREIGN_KEY_CHECKS = 1;

在這里插入圖片描述

三、Web應用專案集成mysql

增加依賴

 <!--Mysql依賴包-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.47</version>
            <scope>runtime</scope>
        </dependency>
 <!-- 資料庫連接池:druid資料源驅動 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.1.10</version>
        </dependency>

Spring資料源配置

###資料源配置
spring:
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    username: root
    password: root
    driver-class-name: net.sf.log4jdbc.sql.jdbcapi.DriverSpy
    url: jdbc:log4jdbc:mysql://localhost:3306/user_info?serverTimezone=Asia/Shanghai&characterEncoding=utf8&useSSL=false&allowPublicKeyRetrieval=true

四、添加Spring Data JPA和Mybatis依賴

<!--pom.xml-->
		<!--Spring Data JPA-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
         <!-- mybatis -->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.2</version>
        </dependency>

五、添加資料表映射物體類

/**
 * 用戶類--映射表user
 *
 * @author zhuhuix
 */
@Entity
@Table(name="user_info")
public class User implements Serializable {
    // 用戶id
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    // 用戶名
    @NotBlank(message = "用戶名稱不能為空")
    @Column(name="name")
    private String name;
    // 郵箱
    @Column(name="email")
    @Pattern(message ="郵箱格式不符", regexp = "^[A-Za-z0-9\\u4e00-\\u9fa5]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$")
    private String email;

    public User(Long id, String name, String email) {
        this.id = id;
        this.name = name;
        this.email = email;
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }
}

六、創建資料介面層

6.1 宣告JPA介面

借助Spring Data JPA，我們可以通過繼承CrudRepository介面，快速定義應用的資料層，CrudRepository定義并實作了很多用于crud（創建、讀取、更新、洗掉）操作的方法，我們根本就不用撰寫實作類！當應用啟動的時候，Spring Data JPA會在運行期自動生成實作類，

/**
 * 基于SpringMVC框架開發web應用--資料操作層
 */
public interface UserRepository extends CrudRepository<User,Long> {

}

CrudRepository的一些默認實作

public interface CrudRepository<T, ID> extends Repository<T, ID> {
    <S extends T> S save(S var1);

    <S extends T> Iterable<S> saveAll(Iterable<S> var1);

    Optional<T> findById(ID var1);

    boolean existsById(ID var1);

    Iterable<T> findAll();

    Iterable<T> findAllById(Iterable<ID> var1);

    long count();

    void deleteById(ID var1);

    void delete(T var1);

    void deleteAll(Iterable<? extends T> var1);

    void deleteAll();
}

6.2 宣告MyBatis介面

雖然強大的Spring Data JPA已經幫我們封裝了多種資料操作，但由于業務邏輯的復雜度及自定義 SQL的需求，我們仍然可以運用MyBatis框架完成ORM的處理，

/**
 * mybatis資料層介面
 *
 */
@Repository
public interface UserMapper {

    // 自定義添加通過用戶名稱模糊查找用戶資訊
    List<User> findByName(String name);
    
}

Mybatis 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.example.demo.mybatis.UserMapper">
	<!-- 自定義模糊查找 SQL -->
    <select id="findByName" resultType="com.example.demo.register.User">
        select * from user where name like concat('%',#{name},'%')
    </select>

</mapper>

Spring添加MyBatis配置
修改application.yml組態檔：定位mapper檔案掃描路徑

#MyBatis掃描mapper檔案配置
mybatis:
  mapper-locations: classpath:mapper/*Mapper.xml

在這里插入圖片描述

在啟動類里加上注解用于給出需要掃描的mapper檔案路徑

@SpringBootApplication
@MapperScan(basePackages = "com.example.demo.register")
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

七、創建業務服務層

創建UserService服務層直接呼叫由Spring Data JPA及Mybatis介面各自提供的資料操作方法，以實作用戶資訊的增刪改查，

/**
 * 呼叫Spring Data JPA和Mybatis介面進行業務處理
 */
@Service
public class UserService {

    // Spring Data JPA
    @Autowired
    private UserRepository userRepository;
    // Mybatis
    @Autowired
    private UserMapper userMapper;

    // 回傳所有的用戶
    public List<User> listUsers() {
        return (List<User>) userRepository.findAll();
    }

    // 保存用戶
    public User saveUser(User user) {
        return userRepository.save(user);
    }

    // 洗掉用戶
    public void deleteUser(Long id) {
        userRepository.deleteById(id);
    }

    // 查找用戶
    public User findUser(Long id) {
        return userRepository.findById(id).get();
    }

    // 根據名稱查找用戶--Mybatis
    public List<User> searchUser(String name) {
        return userMapper.findByName(name);
    }

}

八、創建控制器

控制器的主要職責是處理HTTP請求傳遞給視圖以便于渲染瀏覽器展現，
SpirngMVC的請求注解

注解	描述
@RequestMapping	通用的請求
@GetMapping	處理HTTP GET請示
@PostMapping	處理HTTP POST請示
@PutMapping	處理HTTP PUT請示
@DeleteMapping	處理HTTP DELETE請示

/**
 * 用戶控制器
 */
@RestController
@RequestMapping("/user")
public class UserController {
    @Autowired
    private UserService userService;

    // 保存用戶并回傳到用戶串列頁面
    @PostMapping
    public ModelAndView saveUser(@Valid User user, Errors errors, Model model) {
        if (errors.hasErrors()) {
            model.addAttribute("user", user);
            if (errors.getFieldError("name") != null) {
                model.addAttribute("nameError", errors.getFieldError("name").getDefaultMessage());
            }
            if (errors.getFieldError("email") != null) {
                model.addAttribute("emailError", errors.getFieldError("email").getDefaultMessage());
            }
            return new ModelAndView("register", "userModel", model);
        }
        userService.saveUser(user);
        //重定向到list頁面
        return new ModelAndView("redirect:/user");
    }

    // 獲取用戶操作表單頁面
    @GetMapping("/form")
    public ModelAndView createForm(Model model, @RequestParam(defaultValue = https://www.cnblogs.com/zhuhuix/p/"0") Long id) {
        if (id > 0) {
            model.addAttribute("user", userService.findUser(id));
        } else {
            model.addAttribute("user", new User());
        }
        return new ModelAndView("register", "userModel", model);
    }

    // 獲取用戶串列顯示頁面
    @GetMapping
    public ModelAndView list(Model model) {
        model.addAttribute("userList", userService.listUsers());
        return new ModelAndView("userlist", "userModel", model);
    }

    // 模糊查找輸入頁面
    @GetMapping("/index")
    public ModelAndView index(Model model) {
        model.addAttribute("user", new User());
        return new ModelAndView("index", "userModel", model);
    }

    // 查找提交并跳轉用戶串列
    @PostMapping("/search")
    public ModelAndView search(@ModelAttribute User user, Model model) {
        model.addAttribute("userList", userService.searchUser(user.getName()));
        return new ModelAndView("userlist", "userModel", model);
    }

    // 洗掉用戶
    @RequestMapping(path = "/del")
    public ModelAndView del(@RequestParam(name = "id") Long id) {
        userService.deleteUser(id);
        return new ModelAndView("redirect:/user");
    }
}

九、設計視圖模板

9.1 設計一個用戶串列的視圖模板

Thymeleaf提供了一個屬性th:each，它會迭代一個元素集合，為集合中的每個條目渲染HTML，我們可以利用這個屬性，設計出用戶的串列視圖，

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org"
      xmlns:layout="http://www.ultrag.net.nz/thymeleaf/layout"
>
<head>
    <meta charset="UTF-8">
</head>
<body>
<h3>用戶串列</h3>
<div>
    <a th:href=https://www.cnblogs.com/zhuhuix/p/"@{/user/form}">創建用戶
    查找用戶

ID	郵箱	名稱	操作
沒有用戶資訊！
			修改洗掉

郵箱

名稱

操作

沒有用戶資訊！

修改洗掉

<!DOCTYPE html> <html xmlns:th="http://www.thymeleaf.org" xmlns:layout="http://www.ultrag.net.nz/thymeleaf/layout" > <head> <meta charset="UTF-8"> </head> <body> <h3>登記用戶</h3> <form action="/users" th:action="@{/user}" method="POST" th:object="${userModel.user}"> <input type="hidden" name="id" th:value=https://www.cnblogs.com/zhuhuix/p/"*{id}"> 名稱：郵箱：

 <!DOCTYPE html> <html xmlns:th="http://www.thymeleaf.org" > <head> <meta charset="UTF-8"/> <title>Title</title> </head> <body> <h3>查找用戶</h3> <form action="/users" th:action="@{/user/search}" method="POST" th:object="${userModel.user}"> 名稱：<br> <input type="text" name="name" th:value=https://www.cnblogs.com/zhuhuix/p/"*{name}" >

我的博客即將同步至騰訊云+社區，邀請大家一同入駐：https://cloud.tencent.com/developer/support-plan?invite_code=1lslxkle78msp