TranslateProject/published/201912/20191007 Using the Java Persistence API.md

266 lines
13 KiB
Markdown
Raw Normal View History

2019-12-23 09:08:16 +08:00
[#]: collector: (lujun9972)
[#]: translator: (runningwater)
2019-12-26 23:58:15 +08:00
[#]: reviewer: (wxy)
[#]: publisher: (wxy)
[#]: url: (https://linux.cn/article-11717-1.html)
2019-12-23 09:08:16 +08:00
[#]: subject: (Using the Java Persistence API)
[#]: via: (https://opensource.com/article/19/10/using-java-persistence-api)
[#]: author: (Stephon Brown https://opensource.com/users/stephb)
使用 Java 持久化 API
======
2019-12-26 23:58:15 +08:00
> 我们通过为自行车商店构建示例应用程序来学习如何使用 JPA。
2019-12-23 09:08:16 +08:00
![](https://img.linux.net.cn/data/attachment/album/201912/27/000705dymv92hnba2a2322.jpg)
2019-12-23 09:08:16 +08:00
2019-12-26 23:58:15 +08:00
对应用开发者来说,<ruby>Java 持久化 API<rt>Java Persistence API</rt></ruby>JPA是一项重要的 java 功能,需要透彻理解。它为 Java 开发人员定义了如何将对象的方法调用转换为访问、持久化及管理存储在 NoSQL 和关系型数据库中的数据的方案。
2019-12-23 09:08:16 +08:00
2019-12-26 23:58:15 +08:00
本文通过构建自行车借贷服务的教程示例来详细研究 JPA。此示例会使用 Spring Boot 框架、MongoDB 数据库([已经不开源][2])和 Maven 包管理来构建一个大型应用程序并且构建一个创建、读取、更新和删除CRUD层。这儿我选择 NetBeans 11 作为我的 IDE。
2019-12-23 09:08:16 +08:00
2019-12-26 23:58:15 +08:00
此教程仅从开源的角度来介绍 Java 持久化 API 的工作原理,不涉及其作为工具的使用说明。这全是关于编写应用程序模式的学习,但对于理解具体的软件实现也很益处。可以从我的 [GitHub 仓库][3]来获取相关代码。
2019-12-23 09:08:16 +08:00
2019-12-26 23:58:15 +08:00
### Java: 不仅仅是“豆子”
2019-12-23 09:08:16 +08:00
2019-12-26 23:58:15 +08:00
Java 是一门面向对象的编程语言,自 1996 年发布第一版 Java 开发工具JDK已经变化了很多很多。要了解其各种发展及其虚拟机本身就是一堂历史课。简而言之和 Linux 内核很相似,自发布以来,该语言已经向多个方向分支发展。有对社区免费的标准版本、有针对企业的企业版本及由多家供应商提供的开源替代品。主要版本每六个月发布一次,其功能往往差异很大,所以确认选用版本前得先做些研究。
2019-12-23 09:08:16 +08:00
2019-12-26 23:58:15 +08:00
总而言之Java 的历史很悠久。本教程重点介绍 Java 11 的开源实现 [JDK 11][4]。因其是仍然有效的长期支持版本之一。
2019-12-23 09:08:16 +08:00
2019-12-26 23:58:15 +08:00
* **Spring Boot** 是由 Pivotal 公司开发的大型 Spring 框架的一个模块。Spring 是 Java 开发中一个非常流行的框架。它支持各种框架和配置,也为 WEB 应用程序及安全提供了保障。Spring Boot 为快速构建各种类型的 Java 项目提供了基本的配置。本教程使用 Spring Boot 来快速编写控制台应用程序并针对数据库编写测试用例。
* **Maven** 是由 Apache 开发的项目/包管理工具。Maven 通过 `POM.xml` 文件来管理包及其依赖项。如果你使用过 NPM 的话,可能会非常熟悉包管理器的功能。此外 Maven 也用来进行项目构建及生成功能报告。
* **Lombok** 是一个库,它通过在对象文件里面添加注解来自动创建 getters/setters 方法。像 C# 这些语言已经实现了此功能Lombok 只是把此功能引入 Java 语言而已。
* **NetBeans** 是一款很流行的开源 IDE专门用于 Java 开发。它的许多工具都随着 Java SE 和 EE 的版本更新而更新。
2019-12-23 09:08:16 +08:00
2019-12-26 23:58:15 +08:00
我们会用这组工具为一个虚构自行车商店创建一个简单的应用程序。会实现对 `Customer``Bike` 对象集合的的插入操作。
2019-12-23 09:08:16 +08:00
### 酿造完美
导航到 [Spring Initializr][5] 页面。该网站可以生成基于 Spring Boot 和其依赖项的基本项目。选择以下选项:
2019-12-26 23:58:15 +08:00
1. **项目:** Maven 工程
2. **语言:** Java
3. **Spring Boot** 2.1.8(或最稳定版本)
4. **项目元数据:** 无论你使用什么名字,其命名约定都是像 `com.stephb` 这样的。
2019-12-23 09:08:16 +08:00
* 你可以保留 Artifact 名字为 “Demo”。
2019-12-26 23:58:15 +08:00
5. **依赖项:** 添加:
2019-12-23 09:08:16 +08:00
* Spring Data MongoDB
* Lombok
点击 **下载**,然后用你的 IDE例如 NetBeans 打开此新项目。
2019-12-26 23:58:15 +08:00
#### 模型层概要
2019-12-23 09:08:16 +08:00
2019-12-26 23:58:15 +08:00
在项目里面,<ruby>模型<rt>model</rt></ruby>代表从数据库里取出的信息的具体对象。我们关注两个对象:`Customer` 和 `Bike`。首先,在 `src` 目录创建 `dto` 目录;然后,创建两个名为 `Customer.java``Bike.java` 的 Java 类对象文件。其结构如下示:
2019-12-23 09:08:16 +08:00
2019-12-26 23:58:15 +08:00
```Java
package com.stephb.JavaMongo.dto;
import lombok.Getter;
import lombok.Setter;
import org.springframework.data.annotation.Id;
/**
*
* @author stephon
*/
@Getter @Setter
public class Customer {
private @Id String id;
private String emailAddress;
private String firstName;
private String lastName;
private String address;
}
2019-12-23 09:08:16 +08:00
```
2019-12-26 23:58:15 +08:00
*Customer.Java*
2019-12-23 09:08:16 +08:00
```Java
2019-12-26 23:58:15 +08:00
package com.stephb.JavaMongo.dto;
import lombok.Getter;
import lombok.Setter;
import org.springframework.data.annotation.Id;
/**
*
* @author stephon
*/
@Getter @Setter
public class Bike {
private @Id String id;
private String modelNumber;
private String color;
private String description;
@Override
public String toString() {
return "This bike model is " + this.modelNumber + " is the color " + this.color + " and is " + description;
}
}
2019-12-23 09:08:16 +08:00
```
2019-12-26 23:58:15 +08:00
*Bike.java*
2019-12-23 09:08:16 +08:00
2019-12-26 23:58:15 +08:00
如你所见,对象中使用 Lombok 注解来为定义的<ruby>属性<rt>properties</rt></ruby>/<ruby>特性<rt>attributes</rt></ruby>生成 getters/setters 方法。如果你不想对该类的所有特性都生成 getters/setters 方法,可以在属性上专门定义这些注解。这两个类会变成容器,里面携带有数据,无论在何处想显示信息都可以使用。
2019-12-23 09:08:16 +08:00
2019-12-26 23:58:15 +08:00
#### 配置数据库
2019-12-23 09:08:16 +08:00
2019-12-26 23:58:15 +08:00
我使用 [Mongo Docker][7] 容器来进行此次测试。如果你的系统上已经安装了 MongoDB则不必运行 Docker 实例。你也可以登录其官网,选择系统信息,然后按照安装说明来安装 MongoDB。
2019-12-23 09:08:16 +08:00
2019-12-26 23:58:15 +08:00
安装后就可以使用命令行、GUI例如 MongoDB Compass或用于连接数据源的 IDE 驱动程序来与新的 MongoDB 服务器进行交互。到目前为止,可以开始定义数据层了,用来拉取、转换和持久化数据。需要设置数据库访问属性,请导航到程序中的 `applications.properties` 文件,然后添加如下内容:
2019-12-23 09:08:16 +08:00
```
2019-12-26 23:58:15 +08:00
spring.data.mongodb.host=localhost
spring.data.mongodb.port=27017
spring.data.mongodb.database=BikeStore
2019-12-23 09:08:16 +08:00
```
2019-12-26 23:58:15 +08:00
#### 定义数据访问对象/数据访问层
2019-12-23 09:08:16 +08:00
2019-12-26 23:58:15 +08:00
<ruby>数据访问层<rt>data access layer</rt></ruby>DAL中的<ruby>数据访问对象<rt>data access objects</rt></ruby>DAO定义了与数据库中的数据的交互过程。令人惊叹的就是在使用 `spring-boot-starter` 后,查询数据库的大部分工作已经完成。
2019-12-23 09:08:16 +08:00
2019-12-26 23:58:15 +08:00
让我们从 `Customer` DAO 开始。在 `src` 下的新目录 `dao` 中创建一个接口文件,然后再创建一个名为 `CustomerRepository.java` 的 Java 类文件,其内容如下示:
2019-12-23 09:08:16 +08:00
```
2019-12-26 23:58:15 +08:00
package com.stephb.JavaMongo.dao;
import com.stephb.JavaMongo.dto.Customer;
import java.util.List;
import org.springframework.data.mongodb.repository.MongoRepository;
/**
*
* @author stephon
*/
public interface CustomerRepository extends MongoRepository<Customer, String>{
@Override
public List<Customer> findAll();
public List<Customer> findByFirstName(String firstName);
public List<Customer> findByLastName(String lastName);
}
2019-12-23 09:08:16 +08:00
```
2019-12-26 23:58:15 +08:00
这个类是一个接口,扩展或继承于 `MongoRepository` 类,而 `MongoRepository` 类依赖于 DTO `Customer.java`)和一个字符串,它们用来实现自定义函数查询功能。因为你已继承自此类,所以你可以访问许多方法函数,这些函数允许持久化和查询对象,而无需实现或引用自己定义的方法函数。例如,在实例化 `CustomerRepository` 对象后,你就可以直接使用 `Save` 函数。如果你需要扩展更多的功能,也可以重写这些函数。我创建了一些自定义查询来搜索我的集合,这些集合对象是我自定义的元素。
2019-12-23 09:08:16 +08:00
2019-12-26 23:58:15 +08:00
`Bike` 对象也有一个存储源负责与数据库交互。与 `CustomerRepository` 的实现非常类似。其实现如下所示:
2019-12-23 09:08:16 +08:00
```
2019-12-26 23:58:15 +08:00
package com.stephb.JavaMongo.dao;
import com.stephb.JavaMongo.dto.Bike;
import java.util.List;
import org.springframework.data.mongodb.repository.MongoRepository;
/**
*
* @author stephon
*/
public interface BikeRepository extends MongoRepository<Bike,String>{
public Bike findByModelNumber(String modelNumber);
@Override
public List<Bike> findAll();
public List<Bike> findByColor(String color);
}
2019-12-23 09:08:16 +08:00
```
#### 运行程序
现在,你已经有了一种结构化数据的方式,可以对数据进行提取、转换和持久化,然后运行这个程序。
2019-12-26 23:58:15 +08:00
找到 `Application.java` 文件(有可能不是此名称,具体取决于你的应用程序名称,但都会包含有 “application” )。在定义此类的地方,在后面加上 `implements CommandLineRunner`。这将允许你实现 `run` 方法来创建命令行应用程序。重写 `CommandLineRunner` 接口提供的 `run` 方法,并包含如下内容用来测试 `BikeRepository`
2019-12-23 09:08:16 +08:00
```
2019-12-26 23:58:15 +08:00
package com.stephb.JavaMongo;
import com.stephb.JavaMongo.dao.BikeRepository;
import com.stephb.JavaMongo.dao.CustomerRepository;
import com.stephb.JavaMongo.dto.Bike;
import java.util.Scanner;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class JavaMongoApplication implements CommandLineRunner {
@Autowired
private BikeRepository bikeRepo;
private CustomerRepository custRepo;
public static void main(String[] args) {
SpringApplication.run(JavaMongoApplication.class, args);
}
@Override
public void run(String... args) throws Exception {
Scanner scan = new Scanner(System.in);
String response = "";
boolean running = true;
while(running){
System.out.println("What would you like to create? \n C: The Customer \n B: Bike? \n X:Close");
response = scan.nextLine();
if ("B".equals(response.toUpperCase())) {
String[] bikeInformation = new String[3];
System.out.println("Enter the information for the Bike");
System.out.println("Model Number");
bikeInformation[0] = scan.nextLine();
System.out.println("Color");
bikeInformation[1] = scan.nextLine();
System.out.println("Description");
bikeInformation[2] = scan.nextLine();
Bike bike = new Bike();
bike.setModelNumber(bikeInformation[0]);
bike.setColor(bikeInformation[1]);
bike.setDescription(bikeInformation[2]);
bike = bikeRepo.save(bike);
System.out.println(bike.toString());
} else if ("X".equals(response.toUpperCase())) {
System.out.println("Bye");
running = false;
} else {
System.out.println("Sorry nothing else works right now!");
}
}
}
}
2019-12-23 09:08:16 +08:00
```
2019-12-26 23:58:15 +08:00
其中的 `@Autowired` 注解会自动依赖注入 `BikeRepository``CustomerRepository` Bean。我们将使用这些类来从数据库持久化和采集数据。
2019-12-23 09:08:16 +08:00
已经好了。你已经创建了一个命令行应用程序。该应用程序连接到数据库,并且能够以最少的代码执行 CRUD 操作
### 结论
2019-12-26 23:58:15 +08:00
从诸如对象和类之类的编程语言概念转换为用于在数据库中存储、检索或更改数据的调用对于构建应用程序至关重要。Java 持久化 APIJPA正是为 Java 开发人员解决这一难题的重要工具。你正在使用 Java 操纵哪些数据库呢?请在评论中分享。
2019-12-23 09:08:16 +08:00
--------------------------------------------------------------------------------
via: https://opensource.com/article/19/10/using-java-persistence-api
作者:[Stephon Brown][a]
选题:[lujun9972][b]
译者:[runningwater](https://github.com/runningwater)
2019-12-26 23:58:15 +08:00
校对:[wxy](https://github.com/wxy)
2019-12-23 09:08:16 +08:00
本文由 [LCTT](https://github.com/LCTT/TranslateProject) 原创编译,[Linux中国](https://linux.cn/) 荣誉推出
[a]: https://opensource.com/users/stephb
[b]: https://github.com/lujun9972
[1]: https://opensource.com/sites/default/files/styles/image-full-size/public/lead-images/java-coffee-beans.jpg?itok=3hkjX5We (Coffee beans)
[2]: https://www.techrepublic.com/article/mongodb-ceo-tells-hard-truths-about-commercial-open-source/
[3]: https://github.com/StephonBrown/SpringMongoJava
[4]: https://openjdk.java.net/projects/jdk/11/
[5]: https://start.spring.io/
[6]: http://www.google.com/search?hl=en&q=allinurl%3Adocs.oracle.com+javase+docs+api+string
[7]: https://hub.docker.com/_/mongo
[8]: http://www.google.com/search?hl=en&q=allinurl%3Adocs.oracle.com+javase+docs+api+exception
[9]: http://www.google.com/search?hl=en&q=allinurl%3Adocs.oracle.com+javase+docs+api+system