一简介
(1)MySQL 是一个关系型数据库系统, 是如今互联网公司最常用的数据库和最广泛的数据库为服务端数据库, 能承受高并发的访问量
(2)Spring-Data-Jpa 是在 JPA 规范下提供的 Repository 层的实现, 可以使用不同的实现框架如 HibernateOpenJpa 等框架进行开发, 这样可以使得 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-jpaspring-orm 和 Hibernate 来支持 JPA
- -->
- <dependency>
- <groupId>org.springframework.boot</groupId>
- <artifactId>spring-boot-starter-data-jpa</artifactId>
- </dependency>
需要引入三个依赖, jdbc 为 spring 整合 MySQL 需要的依赖, 第二个为 MySQL 的数据库驱动依赖, 第三个为 Spring-Data-Jpa 相关的依赖包含:
其中其包含 AOPjdbcSpring-ORM 事务 Transaction-api 和 Hibernate 等依赖来支持所以 Jpa 默认为使用 Hibernate 进行实现
2 配置文件配置:
配置文件我们选择. yml 格式文件进行配置, 并且使用 dpcp2 配置连接池参数:
1) 项目相关配置:
- server:
- #配置端口号
- port: 8088
- spring:
- 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 属性用于配置生成策略有以下几种枚举值:
1auto - 主键由程序控制
2IDENTITY - 由数据库自动生成
3enerator - 指定生成主键使用的生成器
4SEQUENCE - 根据底层数据库的序列来生成主键
5TABLE - 使用一个特定的数据库表来保存主键
6system-uuid 代表使用系统生成的 uuid 进行配
(5)@Column 用于配置列相关信息的注解
1name 字段用于指定映射到表结构的映射字段
2length 代表此字段的长度约束, 可以省略
3unique 属性代表此字段是否开启唯一性约束, 默认为 false, 唯一则为 true
4nullable 代表此字段是否可以为空, 默认为 true false 代表不能为空
(6)@DateTimeFormat 用于映射数据库表时间的格式
相应的 get 和 set 方法已经省略
3)DeptRepository 层实现
如图, Respository 为一个接口规范, 有不同的子接口继承, 每个子接口除了继承父接口所有功能外还会添加额外的方法, 用于不同的实现 CrudRepository 类定义了基本方法, 其子类分别进行扩展
如 PagingAndSortingRepository 类除了继承 CrudRepository 的所有方法, 还额外对其进行扩展, 增加了分页查找的相关方法:
- Iterable<T> findAll(Sort sort);
- Page<T> findAll(Pageable pageable);
而 JpaRepository 则是在 PagingAndSortingRepository 的基础上再进行扩展
1Repository 层:
@Repository 代表将此类交由 spring 管理, 并且其为一个 dao 层
- /**
- * @功能描述: 用于部门表操作的 dao 层接口
- * @author Administrator
- */
- @Repository// 代表此为一个 dao 层实现
- public interface DeptRepository extends JpaRepository<Dept, String>{
- }
根据实现类不同, 其拥有不同的方法可调用, 一般此处方法大家见名知意都能知道其用法泛型中 < Dept, String> 第一个参数代表表映射的实体类, 第二个参数代表主键类型
2Service 层实现:
- /**
- * @功能描述: 用于部门 service 操作的实现类
- * @author Administrator
- */
- @Service
- public 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 实现的方法
3Controller 层实现:
- @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 测试:
模拟进行发送 get 请求, 完成 Spring-Data-Jpa 与 MySQL 的整合和配置
来源: https://www.cnblogs.com/zeryts/p/8698673.html