SpringBoot 系列教程 JPA 錯誤姿式之環境配置問題

時間 2020-01-19

標籤 springboot 系列教程 jpa 錯誤環境配置問題欄目 Spring 简体版

原文原文鏈接

191218-SpringBoot 系列教程 JPA 錯誤姿式之環境配置問題

又回到 jpa 的教程上了，這一篇源於某個簡單的項目須要讀寫 db，本想着直接使用 jpa 會比較簡單，然而悲催的是實際開發過程當中，發現了很多的坑；本文爲錯誤姿式第一篇，Repository 接口沒法注入問題java

mysql

I. 配置問題

新開一個 jpa 項目結合 springboot 能夠很方便的實現，可是在某些環境下，可能會遇到自定義的 JpaRepository 接口沒法注入問題git

1. 基本配置

在 spring-boot 環境中，須要在pom.xml文件中，指定下面兩個依賴github

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>

接下來須要修改一下配置文件(application.properties)，指定數據庫的配置信息spring

## DataSource
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/story?useUnicode=true&characterEncoding=UTF-8&useSSL=false
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.username=root
spring.datasource.password=

spring.jpa.database=MYSQL
spring.jpa.hibernate.ddl-auto=none
spring.jpa.show-sql=true
spring.jpa.hibernate.naming.physical-strategy=org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl

2. 注入失敗 case 復現

首先在 mysql 的 story 庫中，新增一個表sql

CREATE TABLE `meta_group` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `group` varchar(32) NOT NULL DEFAULT '' COMMENT '分組',
  `profile` varchar(32) NOT NULL DEFAULT '' COMMENT 'profile 目前用在應用環境 取值 dev/test/pro',
  `desc` varchar(64) NOT NULL DEFAULT '' COMMENT '解釋說明',
  `deleted` int(4) NOT NULL DEFAULT '0' COMMENT '0表示有效 1表示無效',
  `create_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '建立時間',
  `update_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改時間',
  PRIMARY KEY (`id`),
  KEY `group_profile` (`group`,`profile`)
) ENGINE=InnoDB AUTO_INCREMENT=6 DEFAULT CHARSET=utf8mb4 COMMENT='業務配置分組表';

而後定義這個表對應的 Entity數據庫

@Data
@Entity
@Table(name = "meta_group")
public class MetaGroupPO {
    @Id
    @Column(name = "`id`")
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;

    @Column(name = "`group`")
    private String group;

    @Column(name = "`profile`")
    private String profile;

    @Column(name = "`desc`")
    private String desc;

    @Column(name = "`deleted`")
    private Integer deleted;

    @Column(name = "`create_time`")
    @CreatedDate
    private Timestamp createTime;

    @Column(name = "`update_time`")
    @CreatedDate
    private Timestamp updateTime;
}

對應的 repository 接口springboot

public interface GroupJPARepository extends JpaRepository<MetaGroupPO, Integer> {

    List<MetaGroupPO> findByProfile(String profile);

    MetaGroupPO findByGroupAndProfileAndDeleted(String group, String profile, Integer deleted);

    @Modifying
    @Query("update MetaGroupJpaPO m set m.desc=?2 where m.id=?1")
    int updateDesc(int groupId, String desc);

    @Modifying
    @Query("update MetaGroupJpaPO m set m.deleted=1 where m.id=?1")
    int logicDeleted(int groupId);
}

一個簡單的數據操做封裝類GroupManagerapp

@Component

public class GroupManager {
    @Autowired
    private GroupJPARepository groupJPARepository;

    public MetaGroupPO getOnlineGroup(String group, String profile) {
        return groupJPARepository.findByGroupAndProfileAndDeleted(group, profile, 0);
    }

    public Integer addGroup(String group, String profile, String desc) {
        MetaGroupPO jpa = new MetaGroupPO();
        jpa.setGroup(group);
        jpa.setDesc(desc);
        jpa.setProfile(profile);
        jpa.setDeleted(0);
        Timestamp timestamp = Timestamp.from(Instant.now());
        jpa.setCreateTime(timestamp);
        jpa.setUpdateTime(timestamp);
        MetaGroupPO res = groupJPARepository.save(jpa);
        return res.getId();
    }
}

接下來重點來了，當咱們的啓動類，不是在外面時，可能會出現問題；項目結構以下maven

咱們看一下配置類，和錯誤的啓動應用類

@Configuration
@ComponentScan("com.git.hui.boot.jpacase")
public class JpaCaseAutoConfiguration {
}

@SpringBootApplication
public class ErrorApplication {

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

}

直接啓動失敗，異常以下圖，提示找不到GroupJPARepository這個 bean，而這個 bean 在正常啓動方式中，會由 spring 幫咱們生成一個代理類；而這裏顯然是沒有生成了

3. case 分析

上面的 case 可能有點極端了，通常來說項目啓動類，咱們都會放在最外層；基本上不太會出現上面這種項目結構，那麼分析這個 case 有毛用？

一個典型的 case

咱們將 db 操做的邏輯放在一個 module（如 dao.jar）中封裝起來
而後有一個啓動的 module，經過 maven 引入上 dao.jar
這是入口的默認掃描範圍，可能就沒法包含 dao.jar，所以極有可能致使注入失敗

4. 解決方案

那麼該怎麼解決這個問題呢？

在配置類中，添加兩個註解EnableJpaRepositories與EntityScan，並制定對應的包路徑

@Configuration
@EnableJpaRepositories("com.git.hui.boot.jpacase")
@EntityScan("com.git.hui.boot.jpacase.entity")
public class TrueJpaCaseAutoConfiguration {
}

而後再次測試

@SpringBootApplication
public class TrueApplication {

    public TrueApplication(GroupManager groupManager) {
        int groupId = groupManager.addGroup("true-group", "dev", "正確寫入!!!");
        System.out.println("add groupId: " + groupId);
        MetaGroupPO po = groupManager.getOnlineGroup("true-group", "dev");
        System.out.println(po);
    }

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