Spring Data JPA框架快速入门之自定义Repository接口

下面是关于“Spring Data JPA框架快速入门之自定义Repository接口”的详细讲解。

什么是Spring Data JPA？

Spring Data JPA是Spring提供的一个用于简化JPA开发的框架，它提供了一种使得JPA的使用更加方便快捷的方式，使我们能够以更少的代码量实现JPA数据存储相关的操作。

自定义Repository接口

自定义Repository接口是指在Spring Data JPA框架中，定义一些基于业务逻辑的特定查询方法。这些特定查询方法可以直接在Repository接口中定义，Spring Data JPA框架会自动根据方法的名称，自动生成相应的SQL语句。

以下是自定义Repository接口的定义方式：

public interface UserRepositoryCustom {
    List<User> findByAge(int age);
    void updateUserPassword(User user, String newPassword);
}

自定义Repository接口的实现

自定义Repository接口的实现是指为自定义Repository接口编写相应的实现类。为了实现自定义Repository接口，我们需要添加以下两个类：

• 继承JpaRepository接口的Repository实现类

@Repository
public class UserRepositoryImpl extends SimpleJpaRepository<User, Integer> implements UserRepositoryCustom {
    private final EntityManager entityManager;

    public UserRepositoryImpl(EntityManager entityManager) {
        super(User.class, entityManager);
        this.entityManager = entityManager;
    }

    @Override
    public List<User> findByAge(int age) {
        CriteriaBuilder cb = entityManager.getCriteriaBuilder();
        CriteriaQuery<User> query = cb.createQuery(User.class);
        Root<User> root = query.from(User.class);
        Predicate predicate = cb.equal(root.get("age"), age);
        query.where(predicate);

        TypedQuery<User> typedQuery = entityManager.createQuery(query);
        return typedQuery.getResultList();
    }

    @Override
    @Transactional
    public void updateUserPassword(User user, String newPassword) {
        user.setPwd(newPassword);
        entityManager.merge(user);
    }
}

• 继承自定义Repository接口的接口实现类

public interface UserRepository extends JpaRepository<User, Integer>, UserRepositoryCustom {
}

示例说明

这里提供两个简单的示例，分别是基于age查询用户列表和更新用户密码。

基于age查询用户列表

1. 定义自定义Repository接口

public interface UserRepositoryCustom {
    List<User> findByAge(int age);
}

1. 实现自定义Repository接口

@Repository
public class UserRepositoryImpl extends SimpleJpaRepository<User, Integer> implements UserRepositoryCustom {
    private final EntityManager entityManager;

    public UserRepositoryImpl(EntityManager entityManager) {
        super(User.class, entityManager);
        this.entityManager = entityManager;
    }

    @Override
    public List<User> findByAge(int age) {
        CriteriaBuilder cb = entityManager.getCriteriaBuilder();
        CriteriaQuery<User> query = cb.createQuery(User.class);
        Root<User> root = query.from(User.class);
        Predicate predicate = cb.equal(root.get("age"), age);
        query.where(predicate);

        TypedQuery<User> typedQuery = entityManager.createQuery(query);
        return typedQuery.getResultList();
    }
}

1. 在Controller层调用自定义Repository方法

@RestController
@RequestMapping("/users")
public class UserController {
    @Autowired
    private UserRepository userRepository;

    @GetMapping(value = "/age/{age}")
    public List<User> findUserByAge(@PathVariable int age){
        return userRepository.findByAge(age);
    }
}

更新用户密码

1. 定义自定义Repository接口

public interface UserRepositoryCustom {
    void updateUserPassword(User user, String newPassword);
}

1. 实现自定义Repository接口

@Repository
public class UserRepositoryImpl extends SimpleJpaRepository<User, Integer> implements UserRepositoryCustom {
    private final EntityManager entityManager;

    public UserRepositoryImpl(EntityManager entityManager) {
        super(User.class, entityManager);
        this.entityManager = entityManager;
    }

    @Override
    @Transactional
    public void updateUserPassword(User user, String newPassword) {
        user.setPwd(newPassword);
        entityManager.merge(user);
    }
}

1. 在Controller层调用自定义Repository方法

@RestController
@RequestMapping("/users")
public class UserController {
    @Autowired
    private UserRepository userRepository;

    @PostMapping(value = "/{id}/password")
    public void updateUserPassword(@PathVariable int id, @RequestBody String newPassword){
        User user = userRepository.findById(id).get();
        userRepository.updateUserPassword(user, newPassword);
    }
}

小结

通过自定义Repository接口和实现类可以方便地实现复杂的数据查询和处理操作。相信通过本文的学习，你已经掌握了相关的知识。