我正在寻找Spring Data JPA。考虑下面的例子，我将得到所有的crud和查找器功能默认工作，如果我想自定义一个查找器，那么也可以在界面本身轻松完成。
@Transactional(readOnly = true)
public interface AccountRepository extends JpaRepository<Account, Long> {
@Query("<JPQ statement here>")
List<Account> findByCustomer(Customer customer);
}
我想知道如何添加一个完整的自定义方法及其实现以上AccountRepository?因为它是一个接口，我不能在那里实现方法。
当前回答
如果你想做更复杂的操作，你可能需要访问Spring Data的内部，在这种情况下，下面的工作(作为DATAJPA-422的临时解决方案):
public class AccountRepositoryImpl implements AccountRepositoryCustom {
@PersistenceContext
private EntityManager entityManager;
private JpaEntityInformation<Account, ?> entityInformation;
@PostConstruct
public void postConstruct() {
this.entityInformation = JpaEntityInformationSupport.getMetadata(Account.class, entityManager);
}
@Override
@Transactional
public Account saveWithReferenceToOrganisation(Account entity, long organisationId) {
entity.setOrganisation(entityManager.getReference(Organisation.class, organisationId));
return save(entity);
}
private Account save(Account entity) {
// save in same way as SimpleJpaRepository
if (entityInformation.isNew(entity)) {
entityManager.persist(entity);
return entity;
} else {
return entityManager.merge(entity);
}
}
}
其他回答
如果你想做更复杂的操作，你可能需要访问Spring Data的内部，在这种情况下，下面的工作(作为DATAJPA-422的临时解决方案):
public class AccountRepositoryImpl implements AccountRepositoryCustom {
@PersistenceContext
private EntityManager entityManager;
private JpaEntityInformation<Account, ?> entityInformation;
@PostConstruct
public void postConstruct() {
this.entityInformation = JpaEntityInformationSupport.getMetadata(Account.class, entityManager);
}
@Override
@Transactional
public Account saveWithReferenceToOrganisation(Account entity, long organisationId) {
entity.setOrganisation(entityManager.getReference(Organisation.class, organisationId));
return save(entity);
}
private Account save(Account entity) {
// save in same way as SimpleJpaRepository
if (entityInformation.isNew(entity)) {
entityManager.persist(entity);
return entity;
} else {
return entityManager.merge(entity);
}
}
}
公认的答案是可行的，但有三个问题:
在将自定义实现命名为AccountRepositoryImpl时，它使用了一个未记录的Spring Data特性。文档明确指出它必须被称为AccountRepositoryCustomImpl，即自定义接口名加上Impl 不能使用构造函数注入，只能使用@Autowired，这被认为是不好的做法 在自定义实现中有一个循环依赖(这就是为什么不能使用构造函数注入)。
我找到了一个让它变得完美的方法，尽管不是没有使用另一个未记录的Spring Data特性:
public interface AccountRepository extends AccountRepositoryBasic,
AccountRepositoryCustom
{
}
public interface AccountRepositoryBasic extends JpaRepository<Account, Long>
{
// standard Spring Data methods, like findByLogin
}
public interface AccountRepositoryCustom
{
public void customMethod();
}
public class AccountRepositoryCustomImpl implements AccountRepositoryCustom
{
private final AccountRepositoryBasic accountRepositoryBasic;
// constructor-based injection
public AccountRepositoryCustomImpl(
AccountRepositoryBasic accountRepositoryBasic)
{
this.accountRepositoryBasic = accountRepositoryBasic;
}
public void customMethod()
{
// we can call all basic Spring Data methods using
// accountRepositoryBasic
}
}
这里还有一个问题需要考虑。有些人希望将自定义方法添加到存储库中将自动将其作为'/search'链接下的REST服务公开。不幸的是，事实并非如此。Spring目前不支持这一点。
这是“设计”特性，spring data rest显式检查方法是否为自定义方法，并且不会将其作为rest搜索链接公开:
private boolean isQueryMethodCandidate(Method method) {
return isQueryAnnotationPresentOn(method) || !isCustomMethod(method) && !isBaseClassMethod(method);
}
这是Oliver Gierke的一段话:
这是有意为之。自定义存储库方法不像查询方法那样 它们可以有效地实现任何行为。因此，它目前是 我们不可能决定HTTP方法来公开方法 下。POST是最安全的选择但这与 泛型查询方法(接收GET)。
欲了解更多详细信息，请参阅此问题:https://jira.spring.io/browse/DATAREST-206
有一种稍微修改过的解决方案，它不需要额外的接口。
正如文档中所描述的那样，Impl后缀允许我们有这样一个干净的解决方案:
在你常规的@Repository接口中定义自定义方法，比如MyEntityRepository(除了Spring Data方法之外) 在任何地方创建一个只实现自定义方法的类MyEntityRepositoryImpl (Impl后缀很神奇)(甚至不需要在同一个包中)，并使用@Component**注释这个类(@Repository将不起作用)。 这个类甚至可以通过@Autowired注入MyEntityRepository用于自定义方法。
例子:
实体类(为完整起见):
package myapp.domain.myentity;
@Entity
public class MyEntity {
@Id private Long id;
@Column private String comment;
}
库接口:
package myapp.domain.myentity;
@Repository
public interface MyEntityRepository extends JpaRepository<MyEntity, Long> {
// EXAMPLE SPRING DATA METHOD
List<MyEntity> findByCommentEndsWith(String x);
List<MyEntity> doSomeHql(Long id); // custom method, code at *Impl class below
List<MyEntity> useTheRepo(Long id); // custom method, code at *Impl class below
}
自定义方法实现bean:
package myapp.infrastructure.myentity;
@Component // Must be @Component !!
public class MyEntityRepositoryImpl { // must have the exact repo name + Impl !!
@PersistenceContext
private EntityManager entityManager;
@Autowired
private MyEntityRepository myEntityRepository;
@SuppressWarnings("unused")
public List<MyEntity> doSomeHql(Long id) {
String hql = "SELECT eFROM MyEntity e WHERE e.id = :id";
TypedQuery<MyEntity> query = entityManager.createQuery(hql, MyEntity.class);
query.setParameter("id", id);
return query.getResultList();
}
@SuppressWarnings("unused")
public List<MyEntity> useTheRepo(Long id) {
List<MyEntity> es = doSomeHql(id);
es.addAll(myEntityRepository.findByCommentEndsWith("DO"));
es.add(myEntityRepository.findById(2L).get());
return es;
}
}
用法:
// You just autowire the the MyEntityRepository as usual
// (the Impl class is just impl detail, the clients don't even know about it)
@Service
public class SomeService {
@Autowired
private MyEntityRepository myEntityRepository;
public void someMethod(String x, long y) {
// call any method as usual
myEntityRepository.findByCommentEndsWith(x);
myEntityRepository.doSomeHql(y);
}
}
仅此而已，除了已经拥有的Spring Data回购接口之外，不需要任何接口。
我发现的唯一可能的缺点是:
Impl类中的自定义方法被编译器标记为未使用，因此会出现@SuppressWarnings("unused")建议。 您有一个Impl类的限制。(然而在常规的片段接口实现中，文档建议你可以有很多。) 如果您将Impl类放在不同的包中，并且您的测试只使用@DataJpaTest，那么您必须将@ComponentScan("package.of.the. Impl .clazz")添加到您的测试中，以便Spring加载它。
I扩展了SimpleJpaRepository:
public class ExtendedRepositoryImpl<T extends EntityBean> extends SimpleJpaRepository<T, Long>
implements ExtendedRepository<T> {
private final JpaEntityInformation<T, ?> entityInformation;
private final EntityManager em;
public ExtendedRepositoryImpl(final JpaEntityInformation<T, ?> entityInformation,
final EntityManager entityManager) {
super(entityInformation, entityManager);
this.entityInformation = entityInformation;
this.em = entityManager;
}
}
并将这个类添加到@EnableJpaRepositoryries repositoryBaseClass中。
