JPA即Java Persistence API舅踪,ORM即Object-Relation-Mapping。JPA是ORM規(guī)范侯繁,hibernate是ORM實現(xiàn)组贺。相對于mybatis來說,jpa更注重數(shù)據(jù)模型叠必。對于一個java項目來說荚孵,數(shù)據(jù)模型顯得尤為重要,只看數(shù)據(jù)模型就將近可以了解整個系統(tǒng)架構(gòu)了纬朝。過去流行DO收叶、VO、甚至DTO等等共苛,至少我是搞不清楚的判没,但是jpa可以讓我們用一個model代表所有。國內(nèi)顯然用mybatis遠遠多于jpa隅茎,但是一旦你跟著我解決了一些問題澄峰,相信會有所改觀。
初始化spring項目
注:這里稍微走下idea構(gòu)建spring項目的流程辟犀。
-
選擇Spring Initializr和SDK版本
-
配置項目名稱
- 選擇需要使用的pom包俏竞,當(dāng)然也可以后續(xù)直接在pom.xml添加想要的版本,所有可以填寫的包可以在maven倉庫找到 https://mvnrepository.com/ 。
上面的相當(dāng)于<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.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency>
-
創(chuàng)建完之后魂毁,這幾個文件可以刪掉玻佩,沒啥用。
- 更改配置文件為application.yml或application.yaml
配置mysql連接
這里直接給出我的application.yml配置吧
spring:
profiles:
active: dev
---
spring:
profiles: dev
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://127.0.0.1:3306/kg_pipeline?useSSL=false&useUnicode=true&characterEncoding=UTF-8
username: root
password: goddy
jpa:
hibernate:
ddl-auto: update
show-sql: false
創(chuàng)建model類
創(chuàng)建class席楚,需要注解@Entity咬崔。如果希望生成的表名和class不一致,需要@Table注解
@Entity
@Table(name = "student")
public class User {
}
創(chuàng)建主鍵即id烦秩,主要使用兩種:
- 可以從1一直增加
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Integer id;
- 可以使用uuid垮斯。注意這里需要設(shè)置下長度,因為mysql主鍵不能過長闻镶,jpa默認為255甚脉。
@Id @Column(length = 50)
private String id;
創(chuàng)建普通的屬性丸升。如果屬性為多個單詞铆农,如passWord,jpa會自動轉(zhuǎn)為mysql規(guī)范的pass_word狡耻,非常方便墩剖!如果希望和數(shù)據(jù)庫字段名不一致,需要額外注解@Column夷狰。
@Column(name = "pwd")
private String password;
創(chuàng)建枚舉字段岭皂。默認會存0,1...到數(shù)據(jù)庫代表enum,添加下面的注解來存儲string到數(shù)據(jù)庫沼头。
@Enumerated(EnumType.STRING)
private Gender gender;
創(chuàng)建只可寫入字段爷绘。對于類似密碼的非常有用,希望可以讀取到进倍,但又不希望作為rest api的結(jié)果返回時土至,就可以加這個!當(dāng)然還有其他的Access類別可以切換猾昆。
@JsonProperty(access = Access.WRITE_ONLY)
private String password;
創(chuàng)建不和數(shù)據(jù)庫交互的字段陶因。比如一些用了其他類的字段。
@Transient
private List<Role> roleList;
以上所有的綜合為: (這里的@Data和@Builder為lombok的注解垂蜗,lombok:https://projectlombok.org/)
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonProperty.Access;
import java.util.List;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EnumType;
import javax.persistence.Enumerated;
import javax.persistence.Id;
import javax.persistence.Table;
import javax.persistence.Transient;
import lombok.Builder;
import lombok.Data;
/**
* Created by Goddy on 2019/3/5.
*/
@Data
@Builder(toBuilder = true)
@Entity
@Table(name = "user")
public class User {
@Id @Column(length = 50)
private String id;
private String name;
private Integer age;
@Enumerated(EnumType.STRING)
private Gender gender;
@Transient
private List<Role> roleList;
@JsonProperty(access = Access.WRITE_ONLY)
private String password;
public enum Gender {
MALE,
FEMALE
}
@Data
public static class Role {
private String name;
}
}
創(chuàng)建和數(shù)據(jù)庫交互的repository楷扬,類似mybatis的mapper
import com.goddy.demojpa.domain.User;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;
@Repository
public interface UserRepository extends JpaRepository<User, String> {
}
jpa的語法很多啊,也很簡單贴见!烘苹,一定要過一遍 https://docs.spring.io/spring-data/jpa/docs/2.1.5.RELEASE/reference/html/ 。
舉一些例子片部,相信大家直接就可以讀出語義來螟加。
List<User> findByGender(Gender gender);
Page<User> findByGender(Gender gender, Pageable pageable);
List<User> findByNameContainingIgnoreCase(String name);
List<User> findByIdIn(List<String> ids);
List<User> findTop3ByIdIn(List<String> ids);
List<User> findByIdInOrderByNameDesc(List<String> ids);
List<User> findByNameAndAgeBetween(String name, Integer minAge, Integer maxAge);
當(dāng)然,可能這些并不能滿足我們的需要,那么可以這樣: (方法可以隨便命名)
@Query("select u from #{#entityName} u where u.name = ?1")
List<User> findByName(String name);
@Query("select u from #{#entityName} u where u.age = :age")
List<User> findByAge(@Param("age") Integer age);
如果還不可以的話呢捆探,甚至我們可以用原生的sql語句然爆!
@Query(value = "select * from user where name = ?1",
countQuery = "select count(1) from user where name = ?1", nativeQuery = true)
Page<User> findByName(String name, Pageable pageable);
這里放一個工作中遇到的超級復(fù)雜的場景:給一個userId的List,以及pageable黍图。需要按userIdList的順序返回數(shù)據(jù)曾雕,當(dāng)然也要分頁。我們可以這樣寫:
@Query(value = "select * FROM user where user_id in ?1 ORDER BY FIND_IN_SET(user_id, ?2)",
countQuery = "select * FROM user where user_id in ?1 ORDER BY FIND_IN_SET(user_id, ?2)", nativeQuery = true)
Page<User> findByUserIdsAndOrderByUserIds(List<String> userIds, String userIdsStr, Pageable pageable);
這里的userIdsStr為'11,12'助被。
構(gòu)建sevice
這里需要注意下剖张,基于 SOA 的理念,暴露出來的服務(wù)應(yīng)該是接口揩环。
public interface UserService {
}
@Service
public class DefaultUserService implements UserService {
private final UserRepository userRepository;
@Autowired
public DefaultUserService(UserRepository userRepository) {
this.userRepository = userRepository;
}
}