【SpringBoot實戰】資料訪問

airl發表於2022-04-05

前言

在開發中我們通常會對資料庫的資料進行操作，SpringBoot對關係性和非關係型資料庫的訪問操作都提供了非常好的整合支援。SpringData是spring提供的一個用於簡化資料庫訪問、支援雲服務的開源框架。它是一個傘狀專案，包含大量關係型和非關係型資料庫資料訪問解決方案，讓我們快速簡單的使用各種資料訪問技術，springboot預設採用整合springdata方式統一的訪問層，通過新增大量的自動配置，引入各種資料訪問模板Trmplate以及統一的Repository介面，從而達到簡化資料訪問操作。

這裡我們分別對MyBatis、Redis進行整合。

SpringBoot整合MyBatis

mybatis作為目前運算元據庫的流行框架，spingboot並沒有給出依賴支援，但是mybaitis開發團隊自己提供了啟動器mybatis-spring-boot-starter依賴。
MyBatis是一款優秀的持久層框架，它支援定製sql、儲存過程、高階對映、避免JDBC程式碼和手動引數以及獲取結果集。mybatis不僅支援xml而且支援註解。

環境搭建

建立資料庫

我們建立一個簡單的資料庫並插入一些資料用於我們下面的操作。

# 建立資料庫
CREATE DATABASE studentdata;
# 選擇使用資料庫
USE studentdata;
# 建立表並插入相關資料
DROP TABLE IF EXISTS `t_student`;
CREATE TABLE `t_student` (
  `id` int(20) NOT NULL AUTO_INCREMENT,
  `name` varchar(20) DEFAULT NULL,
  `age` int(8),
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8;
INSERT INTO `t_student` VALUES ('1', 'hjk', '18');
INSERT INTO `t_student` VALUES ('2', '小何', '20');

建立專案並引入相關啟動器

按照之前的方式建立一個springboot專案，並在pom.xml裡匯入依賴。我們建立一個名為springboot-01的springboot專案。並且匯入阿里的資料來源

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.2.2</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.28</version>
        </dependency>
       <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.2.8</version>
        </dependency>

我們可以在IDEA右邊連線上資料庫，便於我們視覺化操作，這個不連線也不會影響我們程式的執行，只是方便我們視覺化。

建立Student的實體類

package com.hjk.pojo;

public class Student {
    private Integer id;
    private String name;
    private Integer age;

    public Student(){

    }

    public Student(String name,Integer age){
        this.id = id;
        this.name = name;
        this.age = age;
    }

    public Integer getId() {
        return id;
    }

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

    public String getName() {
        return name;
    }

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

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "Student{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

在application.properties裡編寫資料庫連線配置。這裡我們使用druid資料來源順便把如何配置資料來源寫了，使用者名稱和密碼填寫自己的。使用其他資料來源需要匯入相關依賴，並且進行配置。springboot2.x版本預設使用的是hikari資料來源。

## 選著資料庫驅動型別
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/studentdata?serverTimezone=UTC
## 使用者名稱
spring.datasource.username=root
## 密碼
spring.datasource.password=123456

spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
## 初始化連線數
spring.datasource.druid.initial-size=20
## 最小空閒數
spring.datasource.druid.min-idle=10
## 最大連線數
spring.datasource.druid.max-active=100

然後我們編寫一個配置類，把durid資料來源屬性值注入，並注入到spring容器中
建立一個config包，並建立名為DataSourceConfig類

package com.hjk.config;

import com.alibaba.druid.pool.DruidDataSource;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.sql.DataSource;

@Configuration  //將該類標記為自定義配置類
public class DataSourceConfig {

    @Bean //注入一個Datasource物件
    @ConfigurationProperties(prefix = "spring.datasource") //注入屬性
    public DataSource getDruid(){
        return new DruidDataSource();
    }
}

目前整個包結構

註解方式整合mybatis

建立一個mapper包，並建立一個StudentMapper介面並編寫程式碼。mapper其實就和MVC裡的dao包差不多。

package com.hjk.mapper;

import com.hjk.pojo.Student;
import org.apache.ibatis.annotations.*;

import java.util.List;

@Mapper  //這個註解是一個mybatis介面檔案，能被spring掃描到容器中
public interface StudentMapper {

    @Select("select * from t_student where id = #{id}")
    public Student getStudentById(Integer id) ;

    @Select("select * from t_student")
    public List<Student> selectAllStudent();

    @Insert("insert into t_student values (#{id},#{name},#{age})")
    public int insertStudent(Student student);

    @Update("update t_student set name=#{name},age=#{age} where id = #{id}")
    public int updataStudent(Student student);

    @Delete("delete from t_student where id=#{id}")
    public int deleteStudent(Integer id);
}

編寫測試類進行測試

package com.hjk;

import com.hjk.mapper.StudentMapper;
import com.hjk.pojo.Student;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;

@SpringBootTest
class Springdata01ApplicationTests {

    @Autowired
    private StudentMapper studentMapper;

    @Test
    public void selectStudent(){
        Student studentById = studentMapper.getStudentById(1);
        System.out.println(studentById.toString());
    }



    @Test
    public void insertStudent(){
        Student student = new Student("你好",16);
        int i = studentMapper.insertStudent(student);
        List<Student> students = studentMapper.selectAllStudent();
        for (Student student1 : students) {
            System.out.println(student1.toString());
        }
    }

    @Test
    public void updateStudent(){
        Student student = new Student("我叫hjk",20);
        student.setId(1);
        int i = studentMapper.updataStudent(student);
        System.out.println(studentMapper.getStudentById(1).toString());
    }

    @Test
    public void deleteStudent(){
        studentMapper.deleteStudent(1);
        List<Student> students = studentMapper.selectAllStudent();
        for (Student student : students) {
            System.out.println(student.toString());
        }
    }


}

在這裡如果你的實體類的屬性名如果和資料庫的屬性名不太一樣的可能返回結果可能為空，我們可以開器駝峰命名匹配對映。
在application.properties新增配置。

## 開啟駝峰命名匹配對映
mybatis.configuration.map-underscore-to-camel-case=true

這裡使用註解實現了整合mybatis。mybatis雖然在寫一些簡單sql比較方便，但是寫一些複雜的sql還是需要xml配置。

使用xml配置Mybatis

我們使用xml要先在application.properties裡配置一下,不然springboot識別不了。

## 配置Mybatis的XML配置路徑
mybatis.mapper-locations=classpath:mapper/*.xml
## 配置XML指定實體類別名
mybatis.type-aliases-package=com.hjk.pojo

我們重新書寫StudentMapper類，然後使用xml實現資料訪問。這裡我們就寫兩個方法，剩下的基本一樣。

package com.hjk.mapper;


import com.hjk.pojo.Student;
import org.apache.ibatis.annotations.Mapper;

import java.util.List;

@Mapper  //這個註解是一個mybatis介面檔案，能被spring掃描到容器中
public interface StudentMapper {

    public Student getStudentById(Integer id) ;

    public List<Student> selectAllStudent();

}

我們在resources目錄下建立一個mapper包，並在該包下編寫StudentMapper.xml檔案。
我們在寫的時候可以去mybatis文件中哪複製模板，然後再寫也可以記錄下來，方便下次寫

<?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.hjk.mapper.StudentMapper"><!--這裡namespace寫對應mapper的全路徑名-->

    <select id="getStudentById" resultType="Student">
        select * from t_student where id = #{id}
    </select>

    <select id="selectAllStudent" resultType="Student">
        select * from t_student;
    </select>

</mapper>

編寫測試

package com.hjk;

import com.hjk.mapper.StudentMapper;
import com.hjk.pojo.Student;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;

@SpringBootTest
class Springdata01ApplicationTests {

    @Autowired
    private StudentMapper studentMapper;

    @Test
    public void selectStudent(){
        Student studentById = studentMapper.getStudentById(2);
        System.out.println(studentById.toString());
    }

    @Test
    public void selectAllStudent(){
        List<Student> students = studentMapper.selectAllStudent();
        for (Student student : students) {
            System.out.println(student.toString());
        }
    }

}

註解和xml優缺點

註解方便，書寫簡單，但是不方便寫複雜的sql。
xml雖然比較麻煩，但是它的可定製化強，能夠實現複雜的sql語言。
兩者結合使用會有比較好的結果。

整合Redis

Redis是一個開源的、記憶體中的資料結構儲存系統，它可以作用於資料庫、快取、訊息中介軟體，並提供多種語言的API。redis支援多種資料結構，String、hasher、lists、sets、等。同時內建了複本replication、LUA指令碼LUA scripting、LRU驅動時間LRU eviction、事務Transaction和不同級別的磁碟持久化persistence、並且通過Redis Sentinel和自動分割槽提供高可用性。

我們新增Redis依賴。

	<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
            <version>2.6.6</version>
        </dependency>

我們在建立三個實體類用於整合，在pojo包中。

Family類

package com.hjk.pojo;

import org.springframework.data.redis.core.index.Indexed;

public class Family {

    @Indexed
    private String type;

    @Indexed
    private String userName;

    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    @Override
    public String toString() {
        return "Family{" +
                "type='" + type + '\'' +
                ", userName='" + userName + '\'' +
                '}';
    }
}

Adderss類

package com.hjk.pojo;

import org.springframework.data.redis.core.index.Indexed;

public class Address {

    @Indexed
    private String city;

    @Indexed
    private String country;

    public String getCity() {
        return city;
    }

    public void setCity(String city) {
        this.city = city;
    }

    public String getCountry() {
        return country;
    }

    public void setCountry(String country) {
        this.country = country;
    }

    @Override
    public String toString() {
        return "Address{" +
                "city='" + city + '\'' +
                ", country='" + country + '\'' +
                '}';
    }
}

Person類

package com.hjk.pojo;

import org.springframework.data.annotation.Id;
import org.springframework.data.redis.core.RedisHash;
import org.springframework.data.redis.core.index.Indexed;

import java.util.List;

@RedisHash("person")
public class Person {

    @Id
    private String id;

    @Indexed
    private String firstName;

    @Indexed
    private String lastName;

    private Address address;

    private List<Family> familyList;

    public String getId() {
        return id;
    }

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

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public Address getAddress() {
        return address;
    }

    public void setAddress(Address address) {
        this.address = address;
    }

    public List<Family> getFamilyList() {
        return familyList;
    }

    public void setFamilyList(List<Family> familyList) {
        this.familyList = familyList;
    }

    @Override
    public String toString() {
        return "Person{" +
                "id='" + id + '\'' +
                ", firstName='" + firstName + '\'' +
                ", lastName='" + lastName + '\'' +
                ", address=" + address +
                ", familyList=" + familyList +
                '}';
    }
}

RedisHash("person")用於指定操作實體類物件在Redis資料庫中的儲存空間，表示Person實體類的資料操作都儲存在Redis資料庫中名為person的儲存下
@Id用標識實體類主鍵。在Redis中會預設生成字串形式的HasHKey表使唯一的實體物件id，也可以手動設定id。
Indexed 用於標識對應屬性在Redis資料庫中的二級索引。索引名稱就是屬性名。

介面整合

編寫Repository介面，建立repository包並建立PersonRepository類

package com.hjk.repository;

import com.hjk.pojo.Person;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.repository.CrudRepository;

import java.util.List;

public interface PersonRepository extends CrudRepository<Person,String> {
    
    List<Person> findByLastName(String lastName);
    Page<Person> findPersonByLastName(String lastName, Pageable pageable);
    List<Person> findByFirstNameAndLastName(String firstName,String lastName);
    List<Person> findByAddress_City(String city);
    List<Person> findByFamilyList_UserName(String userName);
}

這裡介面繼承的使CurdRepository介面，也可以繼承JpaRepository，但是需要匯入相關包。

新增配置檔案
在application.properties中新增redis資料庫連線配置。


## redis伺服器地址
spring.redis.host=127.0.0.1
## redis伺服器練級埠
spring.redis.port=6379
## redis伺服器密碼預設為空
spring.redis.password=

測試

編寫測試類，在測試檔案下建立一個名為RedisTests的類

package com.hjk;

import com.hjk.pojo.Address;
import com.hjk.pojo.Family;
import com.hjk.pojo.Person;
import com.hjk.repository.PersonRepository;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.ArrayList;
import java.util.List;

@SpringBootTest
public class RedisTests {

    @Autowired
    private PersonRepository repository;

    @Test
    public void redisPerson(){

        //建立按物件
        Person person = new Person();
        person.setFirstName("王");
        person.setLastName("nihao");
        Address address = new Address();
        address.setCity("北京");
        address.setCountry("china");
        person.setAddress(address);
        ArrayList<Family> list = new ArrayList<>();
        Family family = new Family();
        family.setType("父親");
        family.setUserName("你爸爸");
        list.add(family);
        person.setFamilyList(list);

        //向redis資料庫新增資料
        Person save = repository.save(person);
        System.out.println(save);
    }

    @Test
    public void selectPerson(){
        List<Person> list = repository.findByAddress_City("北京");
        for (Person person : list) {
            System.out.println(person);
        }
    }

    @Test
    public void updatePerson(){
        Person person = repository.findByFirstNameAndLastName("王", "nihao").get(0);
        person.setLastName("小明");
        Person save = repository.save(person);
        System.out.println(save);
    }


    @Test
    public void deletePerson(){
        Person person = repository.findByFirstNameAndLastName("王", "小明").get(0);
        repository.delete(person);

    }

}

總結

我們分別對mybatis和redis進行整合。
mybaitis：
註解：匯入依賴->建立實體類->屬性配置->編寫配置類->編寫mapper介面->進行測試。
xml：匯入依賴->建立實體類->屬性配置（配置資料庫等，配置xml路徑）->mapper介面->xml實現->測試
redis：匯入依賴->實體類->實現介面->配置redis屬性->測試

SpringBoot 實戰 (六) | 用 JdbcTemplates 訪問 Mysql
2019-02-17
Spring BootJDBCMySql
SpringBoot資料訪問（一） SpringBoot整合Mybatis
2021-06-17
Spring BootMyBatis
SpringBoot資料訪問（三） SpringBoot整合Redis
2021-07-01
Spring BootRedis
SpringBoot資料訪問（二） SpringBoot整合JPA
2021-06-21
Spring Boot
SpringBoot資料訪問之Druid資料來源的使用
2021-08-06
Spring BootUI
SpringBoot資料訪問之整合Mybatis配置檔案
2021-08-08
Spring BootMyBatis
SpringBoot資料訪問之整合mybatis註解版
2021-08-28
Spring BootMyBatis
SpringBoot靜態資源訪問
2020-12-08
Spring Boot
SpringBoot資料訪問之Druid啟動器的使用
2021-08-07
Spring BootUI
Holer實現外網訪問本地SpringBoot
2018-12-02
Spring Boot
SpringBoot 實戰 (十一) | 整合資料快取 Cache
2019-02-22
Spring Boot快取
Springboot中如何訪問靜態資源
2021-09-09
Spring Boot
SpringBoot實戰：輕鬆實現介面資料脫敏
2024-07-15
Spring Boot
SpringBoot框架整合SpringSecurity實現安全訪問控制
2019-01-28
Spring Boot框架Gse
Spring Boot 揭祕與實戰（二）資料儲存篇 – 資料訪問與多資料來源配置
2019-03-04
Spring Boot
Spring資料訪問
2020-12-11
Spring
springboot新增靜態資源無法訪問
2020-12-22
Spring Boot
Druid未授權訪問實戰利用
2022-01-24
UI
springboot+themeleaf+bootstrap訪問靜態資源/無法訪問靜態資源/圖片
2020-08-26
Spring Boot
JDBC資料庫訪問
2020-11-01
JDBC資料庫
資料訪問 - EntityFramework整合
2022-07-05
Framework
Holer實現外網訪問SQLServer資料庫
2018-12-01
SQLServer資料庫
Holer實現MongoDB資料庫外網訪問
2018-12-02
MongoDB資料庫
Holer實現外網訪問MariaDB資料庫
2018-12-02
資料庫
Holer實現外網訪問PostgreSQL資料庫
2018-12-02
SQL資料庫
Spring Boot實現資料訪問計數器
2021-08-08
Spring Boot
實戰程式碼（二）:Springboot Batch實現定時資料遷移
2020-11-15
Spring BootBAT
SpringBoot之yaml語法及靜態資源訪問
2021-07-29
Spring BootYAML
Oracle DBLink跨資料庫訪問SQL server資料同步踩坑實錄
2019-08-02
Oracle資料庫SQLServer
實戰SpringBoot Admin
2021-01-05
Spring Boot
SpringCloud 實戰：禁止直接訪問後端服務
2021-03-29
SpringGCCloud後端
第五十二章：基於SpringBoot2使用Rest訪問MongoDB資料
2019-02-28
Spring BootRESTMongoDB
springboot無妨訪問html頁面
2020-12-14
Spring BootHTML
外網訪問MySQL資料庫
2018-12-02
MySql資料庫
Ext迭代陣列訪問資料
2019-03-10
陣列
ABP 資料訪問 - IRepository 倉儲
2020-10-29
SQL Server 資料訪問策略：CLRME
2022-03-21
SQLServer
Oracle資料庫限制訪問IP
2023-02-07
Oracle資料庫