spring data jpa使用技巧

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. 可以从1一直增加
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Integer id;
    1. 可以使用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;
  }
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,340评论 5 467
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,762评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,329评论 0 329
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,678评论 1 270
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,583评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 47,995评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,493评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,145评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,293评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,250评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,267评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,973评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,556评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,648评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,873评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,257评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,809评论 2 339

推荐阅读更多精彩内容