springboot之CrudRepository的简单使用

简介：Spring Data JPA 提供了许多与持久化相关的 Repository 接口，其中最常用的是 CrudRepository。CrudRepository 是一个泛型接口，定义了常用的 CRUD 操作方法，包括 create、read、update 和 delete。

CrudRepository 在具体使用场景中非常灵活，可以通过自定义查询方法来实现各种复杂的查询操作。在使用 Spring Data JPA 开发项目时，我们通常会使用 CrudRepository 接口来简化数据访问操作，从而提高开发效率。

使用：下面我们将介绍如何使用 CrudRepository 完成常见的 CRUD 操作。

首先，在项目的 pom.xml 文件中添加依赖：

xml
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>

假设我们有一个用户类 User，它对应一个 user 表，表结构如下：

CREATE TABLE user (
    id BIGINT(20) NOT NULL AUTO_INCREMENT,
    name VARCHAR(50) NOT NULL,
    age INT(11) NOT NULL,
    PRIMARY KEY (id)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

创建实体类
首先，我们需要创建一个实体类，表示数据库中的一个表。使用 JPA 注解来定义实体类的属性和关联关系。例如：

java
@Entity
@Table(name = "user")
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String name;

    private Integer age;

    // getters and setters
}

上面的代码中，使用 @Entity 注解将类声明为实体类，并使用 @Table 注解指定对应的数据表名。@Id 注解表示该字段是主键，@GeneratedValue 注解表示主键自动生成。

创建 Repository 接口
接下来，我们需要创建一个继承自 CrudRepository 的接口，并指定实体类和主键类型。例如：

@Repository
public interface UserRepository extends CrudRepository<User, Long> {
}

上面的代码中，使用 @Repository 注解将接口标记为 Spring Bean，然后继承 CrudRepository 泛型接口，并指定实体类和主键类型。

使用 CRUD 方法
CrudRepository 接口提供了一组常用的 CRUD 方法，包括保存（save）、查询（findById、findAll）、更新（save）和删除（delete）等。可以在业务层直接调用这些方法来操作数据库。

例如，在 UserService 中使用 CrudRepository 完成用户的新增、修改、查询和删除操作：

@Service
public class UserService {

    @Autowired
    private UserRepository userRepository;

    /**
     * 新增用户
     */
    public User save(User user) {
        return userRepository.save(user);
    }

    /**
     * 修改用户
     */
    public User update(User user) {
        return userRepository.save(user);
    }

    /**
     * 根据 ID 查询用户
     */
    public User getById(Long id) {
        return userRepository.findById(id).orElse(null);
    }

    /**
     * 查询所有用户
     */
    public List<User> findAll() {
        return (List<User>) userRepository.findAll();
    }

    /**
     * 根据 ID 删除用户
     */
    public void deleteById(Long id) {
        userRepository.deleteById(id);
    }
}

上面的代码中，使用 @Autowired 注解将 UserRepository 接口注入到 UserService 中，然后通过 CrudRepository 的方法完成对数据库的操作。

自定义查询方法
除了提供的常用 CRUD 方法外，CrudRepository 还支持根据方法命名规则自动生成查询方法。例如，根据用户名查找用户的方法可以命名为 findByUsername。Spring Data JPA 会根据方法名自动生成查询语句。

例如，在 UserRepository 中添加根据用户名查询用户的方法：

@Repository
public interface UserRepository extends CrudRepository<User, Long> {
    User findByUsername(String username);
}

上面的代码中，使用方法名 findByUsername 定义了根据用户名查询用户的方法，Spring Data JPA 会自动生成查询语句。

自定义 JPQL 和 Native SQL
如果需要执行复杂的查询操作，可以使用自定义 JPQL（Java Persistence Query Language）和 Native SQL（原生 SQL）。

例如，在 UserRepository 中添加根据用户名模糊查询用户的方法，使用 JPQL 实现：

@Repository
public interface UserRepository extends CrudRepository<User, Long> {
    @Query("select u from User u where u.name like %:name%")
    List<User> findByNameLike(@Param("name") String name);
}

上面的代码中，使用 @Query 注解定义了 JPQL 查询语句，其中 :name 表示参数，% 表示模糊查询。

还可以使用 Native SQL 查询语句，例如：

@Repository
public interface UserRepository extends CrudRepository<User, Long> {
    @Query(value = "select * from user where name like %:name%", nativeQuery = true)
    List<User> findByNameLike(@Param("name") String name);
}

上面的代码中，使用 @Query 注解定义了 Native SQL 查询语句，其中 value 属性表示查询语句，nativeQuery 属性表示是否使用原生 SQL。

总结：CrudRepository 是 Spring Data JPA 框架提供的一个常用 Repository 接口，它提供了一组基本的 CRUD 操作方法，可以大大简化开发者对数据库的访问操作。在使用 CrudRepository 时，只需要定义实体类和 Repository 接口，就可以通过自动实现的方法完成对数据库的操作。如果需要执行复杂的查询操作，还可以使用自定义 JPQL 和 Native SQL。