要使用 Spring Data JPA 与 JPA 整合来实现数据库访问操作,下面是一个基本的代码示例项目,展示如何使用 Spring Data JPA 实现一个 CRUD 应用。
1. 项目结构
src
├── main
│ ├── java
│ │ └── com
│ │ └── example
│ │ └── springdatajpa
│ │ ├── model # 实体类
│ │ │ └── User.java
│ │ ├── repository # 数据库访问层
│ │ │ └── UserRepository.java
│ │ ├── service # 业务逻辑层
│ │ │ └── UserService.java
│ │ ├── controller # 控制器层
│ │ │ └── UserController.java
│ │ └── SpringDataJpaApplication.java
└── resources
└── application.properties # 配置文件
2. 代码示例
pom.xml配置
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>3.3.4</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>springdata</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>springdata</name>
<description>springdata</description>
<url/>
<licenses>
<license/>
</licenses>
<developers>
<developer/>
</developers>
<scm>
<connection/>
<developerConnection/>
<tag/>
<url/>
</scm>
<properties>
<java.version>23</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</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>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- Oracle JDBC Driver -->
<dependency>
<groupId>com.oracle.database.jdbc</groupId>
<artifactId>ojdbc8</artifactId>
<version>19.8.0.0</version> <!-- 请根据需要选择版本 -->
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<scope>test</scope>
</dependency>
<!-- Hibernate Entity Manager 依赖 -->
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-core</artifactId>
<version>6.0.0.Final</version> <!-- 或者使用最新的 6.x 版本 -->
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!-- MySQL 驱动程序 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.33</version> <!-- 请确保版本号正确 -->
</dependency>
<dependency>
<groupId>org.assertj</groupId>
<artifactId>assertj-core</artifactId>
<version>3.23.1</version> <!-- 或者最新版本 -->
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
2.1. User.java 实体类
这个类用于定义数据库表的映射。在这个例子中,我们使用了 JPA 注解将 User 类映射到数据库表 users。
package com.example.springdatajpa.model;
import javax.persistence.*;
@Entity
@Table(name = "users")
public class User {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
private String username;
private String email;
// Getters and Setters
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
}
2.2. UserRepository.java
这是一个继承了 JpaRepository 的接口,用于定义与数据库的交互操作。Spring Data JPA 会根据接口定义自动生成 CRUD 操作。
package com.example.springdatajpa.repository;
import com.example.springdatajpa.model.User;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;
import java.util.Optional;
@Repository
public interface UserRepository extends JpaRepository<User, Long> {
Optional<User> findByUsername(String username);
}
2.3. UserService.java
UserService 类用于实现业务逻辑,调用 UserRepository 来执行数据操作。
package com.example.springdatajpa.service;
import com.example.springdatajpa.model.User;
import com.example.springdatajpa.repository.UserRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.Optional;
@Service
public class UserService {
@Autowired
private UserRepository userRepository;
public Optional<User> getUserByUsername(String username) {
return userRepository.findByUsername(username);
}
public User createUser(User user) {
return userRepository.save(user);
}
public void deleteUser(Long id) {
userRepository.deleteById(id);
}
}
2.4. UserController.java
UserController 是 RESTful 控制器,它接收来自客户端的 HTTP 请求并返回数据。通过 UserService 调用数据库操作。
package com.example.springdatajpa.controller;
import com.example.springdatajpa.model.User;
import com.example.springdatajpa.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.Optional;
@RestController
@RequestMapping("/users")
public class UserController {
@Autowired
private UserService userService;
@GetMapping("/{username}")
public Optional<User> getUserByUsername(@PathVariable String username) {
return userService.getUserByUsername(username);
}
@PostMapping("/create")
public User createUser(@RequestBody User user) {
return userService.createUser(user);
}
@DeleteMapping("/{id}")
public void deleteUser(@PathVariable Long id) {
userService.deleteUser(id);
}
}
2.5. SpringDataJpaApplication.java
Spring Boot 的启动类,负责启动整个应用程序。
package com.example.springdatajpa;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class SpringDataJpaApplication {
public static void main(String[] args) {
SpringApplication.run(SpringDataJpaApplication.class, args);
}
}
2.6. application.properties 配置文件
Spring Boot 配置文件用于设置数据库连接信息。在这里,连接到一个 MySQL 数据库。
8083
# 数据源配置
spring.datasource.url=jdbc:mysql://localhost:3306/testdb
spring.datasource.username=root
spring.datasource.password=yourpassword
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
# JPA 配置
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL5Dialect
3. 运行项目
Postman使用
-
确保你有一个 MySQL 数据库,并且正确配置了 application.properties 中的数据库连接信息。
-
启动 Spring Boot 项目,Spring Data JPA 会自动创建并管理 users 表(如果表不存在)。
-
使用 Postman 或类似工具发送 HTTP 请求来测试 CRUD 操作。例如:
-
GET 请求:http://localhost:8083/users/{username} 获取指定用户名的用户信息。

-
POST 请求:http://localhost:8083/users/create 创建新用户。


-

- DELETE 请求:http://localhost:8083/users/{id} 删除用户。


本地测试代码如何写

package com.example.springdata;
import static org.assertj.core.api.Assertions.assertThat;
import com.example.springdata.model.User;
import com.example.springdata.repository.UserRepository;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.transaction.annotation.Transactional;
@SpringBootTest
@Transactional // 测试后会自动回滚,保持数据库的干净
public class UserRepositoryTest {
@Autowired
private UserRepository userRepository;
@Test
public void testCreateUser() {
User user = new User();
user.setUsername("testUser");
user.setEmail("test@example.com");
User savedUser = userRepository.save(user);
assertThat(savedUser).isNotNull();
assertThat(savedUser.getId()).isNotNull();
assertThat(savedUser.getUsername()).isEqualTo("testUser");
}
}


4. 总结
Spring Data JPA 极大简化了 JPA 的使用,提供了自动生成 CRUD 方法、分页、排序、查询方法推断等功能,开发者只需定义 Repository 接口即可。
通过与 Spring Boot 的整合,可以快速创建功能完整的 CRUD 应用,减少了大量的样板代码。
10万+

被折叠的 条评论
为什么被折叠?



