JPA即Java Persistence API,ORM即Object-Relation-Mapping。JPA是ORM规范,hibernate是ORM实现。相对于mybatis来说,jpa更注重数据模型。对于一个java项目来说,数据模型显得尤为重要,只看数据模型就将近可以了解整个系统架构了。过去流行DO、VO、甚至DTO等等,至少我是搞不清楚的,但是jpa可以让我们用一个model代表所有。国内显然用mybatis远远多于jpa,但是一旦你跟着我解决了一些问题,相信会有所改观。
初始化spring项目
注:这里稍微走下idea构建spring项目的流程。
-
选择Spring Initializr和SDK版本
-
配置项目名称
- 选择需要使用的pom包,当然也可以后续直接在pom.xml添加想要的版本,所有可以填写的包可以在maven仓库找到 https://mvnrepository.com/ 。
上面的相当于<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>
-
创建完之后,这几个文件可以删掉,没啥用。
- 更改配置文件为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
创建model类
创建class,需要注解@Entity。如果希望生成的表名和class不一致,需要@Table注解
@Entity
@Table(name = "student")
public class User {
}
创建主键即id,主要使用两种:
- 可以从1一直增加
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Integer id;
- 可以使用uuid。注意这里需要设置下长度,因为mysql主键不能过长,jpa默认为255。
@Id @Column(length = 50)
private String id;
创建普通的属性。如果属性为多个单词,如passWord,jpa会自动转为mysql规范的pass_word,非常方便!如果希望和数据库字段名不一致,需要额外注解@Column。
@Column(name = "pwd")
private String password;
创建枚举字段。默认会存0,1...到数据库代表enum,添加下面的注解来存储string到数据库。
@Enumerated(EnumType.STRING)
private Gender gender;
创建只可写入字段。对于类似密码的非常有用,希望可以读取到,但又不希望作为rest api的结果返回时,就可以加这个!当然还有其他的Access类别可以切换。
@JsonProperty(access = Access.WRITE_ONLY)
private String password;
创建不和数据库交互的字段。比如一些用了其他类的字段。
@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;
}
}
创建和数据库交互的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);
当然,可能这些并不能满足我们的需要,那么可以这样: (方法可以随便命名)
@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);
这里放一个工作中遇到的超级复杂的场景:给一个userId的List,以及pageable。需要按userIdList的顺序返回数据,当然也要分页。我们可以这样写:
@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'。
构建sevice
这里需要注意下,基于 SOA 的理念,暴露出来的服务应该是接口。
public interface UserService {
}
@Service
public class DefaultUserService implements UserService {
private final UserRepository userRepository;
@Autowired
public DefaultUserService(UserRepository userRepository) {
this.userRepository = userRepository;
}
}
网友评论