Spring-Data-JPA整合MySQL和配置的方法

2024-07-14 08:39:47

字體：大中小

來源：轉載

供稿：網友

一、簡介

（1）、MySQL是一個關系型數據庫系統,是如今互聯網公司最常用的數據庫和最廣泛的數據庫。為服務端數據庫，能承受高并發的訪問量。

（2）、Spring-Data-Jpa是在JPA規范下提供的Repository層的實現，可以使用不同的實現框架如Hibernate、OpenJpa等框架進行開發,這樣可以使得Repository變得簡單，也解決了其與業務層的耦合性。

本此學習我們使用MySQL+Spring-Data-Jpa搭建,Jpa實現方式使用Hibernate，數據庫連接池使用dbcp進行連接

二、項目搭建

1、引入MySQL以及Jpa相關依賴:

<!-- spring-jdbc相關依賴 --><dependency> <groupId>org.springframework</groupId> <artifactId>spring-jdbc</artifactId></dependency><!-- 用于連接mysql的相關依賴 --><dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId></dependency><!-- jpa相關的依賴 包含spring-data-jpa、spring-orm 和 Hibernate 來支持 JPA --><dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId></dependency>

需要引入三個依賴，jdbc為spring整合MySQL需要的依賴，第二個為MySQL的數據庫驅動依賴,第三個為Spring-Data-Jpa相關的依賴包含：

Spring,Data,JPA整合MySQL,JPA,MySQL

其中其包含AOP、jdbc、Spring-ORM、事務Transaction-api和Hibernate等依賴來支持。所以Jpa默認為使用Hibernate進行實現。

2 、配置文件配置:

配置文件我們選擇.yml格式文件進行配置，并且使用dpcp2配置連接池參數:

1)項目相關配置:

server: #配置端口號 port: 8088spring: application:  #配置服務名稱 name: cms-dept

此處為配置配置服務器開啟的相關信息，主要為配置服務器名稱和端口

2)MySQL相關配置

spring:#數據源和jpa配置 datasource: #數據庫相關的配置url -SSL連接設置為false url: jdbc:mysql://localhost:3306/crm?characterEncoding=utf8&useSSL=false #配置用戶名 username: *** #配置密碼 password: ***

此處為數據庫相關的一些配置,主要為配置數據庫url、賬號和密碼。url后配置信息為連接MySQL的編碼格式和是否啟用SSL加密。

3)DBCP相關配置

spring: #下面為連接池相關配置 dbcp2:  #初始化連接池大小  initial-size: 10  #陪住最小連接池數  min-idle: 10    #配置最大連接池數  max-idle: 30  #配置獲取超時連接的等待時間  max-wait-millis: 30000  #配置多長時間進行一次檢測,檢測需要關閉的數據庫連接  time-between-eviction-runs-millis: 200000  #配置連接在連接池的最小生存時間  remove-abandoned-on-maintenance: 200000

主要配置為一些連接池的信息，配置詳情如上注釋所示。

4）Spring-Data-Jpa依據iHibernata相關配置

spring:  jpa: #配置數據庫類型 database: MYSQL #配置是否打印sql show-sql: true #Hibernate相關配置 hibernate:  #配置級聯等級   ddl-auto: update  naming:  #命名策略  strategy: org.hibernate.cfg.ImprovedNamingStrategy properties:  hibernate:   dialect: org.hibernate.dialect.MySQL5Dialect

配置依次為連接數據庫類型,是否打印Sql和hIbernate級聯方式,有以下幾種:

1)、validate- 加載hibernate時，驗證創建數據庫表結構。

2)、create- 每次加載hibernate，重新創建數據庫表結構，這就是導致數據庫表數據丟失的原因。

3)、create-drop 加載hibernate時創建，退出是刪除表結構。

4)、update-級聯更新加載hibernate自動更新數據庫結構。

我們在此選擇級聯更新，在原有表基礎上進行迭代。

命名策略有以下兩種：

1)、 org.springframework.boot.orm.jpa.hibernate.SpringPhysicalNamingStrategy 遇到大寫字母加”_”的命名。

2)、 org.hibernate.cfg.ImprovedNamingStrategy 無修改命名。

3 、相關類進行配置:

配置類需要配置與氣動類的平級目錄或者子目錄下,才能被配置成功，此處我們使用Java類配置取代xml方式進行配置：

/** * @功能描述:用于MySQL相關配置的類 * @author Administrator *///下面此行用來排序的注解接口,用于處理加載優先級的問題,擁有兩個枚舉變量 @Order(Ordered.HIGHEST_PRECEDENCE)//下面此行代表此類為配置類@Configuration //下面此行代表此類開啟事務管理@EnableTransactionManagement(proxyTargetClass = true)//也可以定義為類 如DeptRepository.class 也可以定義過濾器 includeFilters={ @ComponentScan.Filter(type=FilterType.ANNOTATION,value=Service.class)} @EnableJpaRepositories(basePackages="com.hzt.**.repository")public class MySQLConfig {  @Bean PersistenceExceptionTranslationPostProcessor persistenceExceptionTranslationPostProcessor() {  return new PersistenceExceptionTranslationPostProcessor(); }}

1）、@Order注解，用于配置類的加載優先級別,其擁有兩個枚舉變量：
　　　Ordered.HIGHEST_PRECEDENCE- Integer.MIN_VALUE -最小值,擁有最高優先級
　　　Ordered.LOWEST_PRECEDENCE -Integer.MAX_VALUE -最大值,擁有最低優先級

2)、@Configuration 注解，代表此類為配置類

3)、@EnableTransactionManagement 用于MySQL的事務管理 proxyTargetClass= true代表開啟類的事務管理

4)、@EnableJpaRepositories 用于配置事務,此處以cgnl表達式表示路徑,也可以定義為具體的類,例如DeptRepository.class
　　其子元素includeFilters可以定義事務攔截器,如includeFilters={ @ComponentScan.Filter(type=FilterType.ANNOTATION,value=Service.class)}

4 、ORM映射Java類相關代碼:

1)數據庫表結構

2)實體類映射

@Entity //代表此類為一個表的映射entity類@Table(name="tbl_dept") //設置對應的表名public class Dept implements Serializable{ /**  * 功能描述:序列化時候的唯一性，相應的get和set方法已經省略。  */ private static final long serialVersionUID = 1L; /** 主鍵-id uuid */ @Id //此備注代表該字段為該類的主鍵 @GeneratedValue(generator="system-uuid") @GenericGenerator(name="system-uuid",strategy = "uuid") //name - 指定對應列的名稱 ,length - 最大長度 @Column(name="id",length=32) // private String id; /** 數字,具有唯一性 */ //nullable - 是否可以為null,默認為true unique - 是否唯一,默認為false @Column(name="no",nullable=false,unique=true) private Integer no; /** 部門名稱 */ @Column(name="name",unique=true,nullable=false) private String name; /** 部門管理的主鍵-id uuid */ @Column(name="manager",unique=true,nullable=false) private String manager; /** 部門描述 */ @Column(name="description") private String description; /** 部門電話 */ @Column(name="phone") private String phone; /** 部門創建時間 */ @Column(name="createTime")　　@DateTimeFormat(pattern="yyyy-MM-dd HH:mm:ss") private Date createTime; /** 部門修改時間 */ @Column(name="editTime")　　@DateTimeFormat(pattern="yyyy-MM-dd HH:mm:ss") private Date editTime;}

(1)、@Entity 代表此類映射為數據庫的表結構
(2)、@Table(name="tbl_dept")此注解用于配置實體類與表映射的關系,name代表映射的表名
(3)、 @Id注解代表此類為一個主鍵
(4)、@GeneratedValue注解用于配置主鍵相關信息,generator屬性用于配置生成策略有以下幾種枚舉值:
　　1、auto - 主鍵由程序控制。
　　2、IDENTITY - 由數據庫自動生成。
　　3、enerator -指定生成主鍵使用的生成器。
　4、SEQUENCE - 根據底層數據庫的序列來生成主鍵。
　　5、TABLE - 使用一個特定的數據庫表來保存主鍵。
　　6、system-uuid 代表使用系統生成的uuid進行配。
(5)、@Column用于配置列相關信息的注解
　　1、name字段用于指定映射到表結構的映射字段。
　　2、length代表此字段的長度約束,可以省略。
　　3、unique屬性代表此字段是否開啟唯一性約束，默認為false,唯一則為true 。
　　4、nullable代表此字段是否可以為空,默認為true 。 false代表不能為空。
（6）、@DateTimeFormat用于映射數據庫表時間的格式。
相應的get和set方法已經省略。

3)DeptRepository層實現

Spring,Data,JPA整合MySQL,JPA,MySQL

如圖，Respository為一個接口規范,有不同的子接口繼承,每個子接口除了繼承父接口所有功能外還會添加額外的方法,用于不同的實現。CrudRepository類定義了基本方法,其子類分別進行擴展。
如PagingAndSortingRepository類除了繼承CrudRepository的所有方法,還額外對其進行擴展,增加了分頁查找的相關方法:

Iterable<T> findAll(Sort sort);Page<T> findAll(Pageable pageable);

而JpaRepository則是在PagingAndSortingRepository的基礎上再進行擴展。

1、Repository層:

@Repository 代表將此類交由spring管理,并且其為一個dao層

/** * @功能描述:用于部門表操作的dao層接口 * @author Administrator */@Repository//代表此為一個dao層實現public interface DeptRepository extends JpaRepository<Dept, String>{}

根據實現類不同，其擁有不同的方法可調用，一般此處方法大家見名知意都能知道其用法。泛型中<Dept, String> 第一個參數代表表映射的實體類,第二個參數代表主鍵類型。

2、Service層實現:

/** * @功能描述:用于部門service操作的實現類 * @author Administrator */@Servicepublic class DeptServiceImpl implements DeptService{ /** 日志處理類 */ private final Logger log = LoggerFactory.getLogger(getClass());  @Autowired private DeptRepository repository;  @Override public Dept queryById(String id) throws Exception {  try {   Dept result = repository.findOne(id);   log.info(result.toString());   return result;  }catch (Exception e) {   log.info(e.toString(),e);   throw new ServiceException("根據id查詢時發生異常!");  } }}

其中findOne為JpaRepository實現的方法。

3、Controller層實現:

@RestController@RequestMapping("/api/v1/dept")public class DeptController{ /** 日志記錄類 */ private Logger log = LoggerFactory.getLogger(getClass()); /** 自家的service */ @Autowired private DeptService service;  /**  * @功能描述:根據id查詢部門內容的方法  * @return Dept  */ @GetMapping("/id/get") public Result getById( String id) throws Exception{  verify(new VerifyParam("部門id", id));  return new Result("通過id獲取部門信息成功!", service.queryById(id)); }}

其中RestController代表此Controller為返回Json格式的控制器，@RequestMapping定義其類映射的url,此處我們接受的數據為普通String類型,如果需要接受Json類型,則需 @RequestBody String id 如此配置接受請求參數。

4 、測試: