如何为Repository添加自定义方法

为repository添加自定义方法

一、为某个repository添加自定义方法

1、定义一个接口persondao，声明要添加的方法。

public interface persondao{
 public list<person> getlist();
}

2、提供该接口的实现类personrepositoryimpl。类名需在要与声明的 repository 后添加 impl，并实现persondao中声明的方法。

@repository
public class personrepositoryimpl implements persondao{
 @persistencecontext
 private entitymanager em;
 
 @override
 public list<person> getlist() {
  query query = em.createquery("from person");
  return query.getresultlist();
 }
}

3、使用repository 接口, 并继承persondao接口。

public interface personrepository 
 extends jparepository<person, integer>, jpaspecificationexecutor<person>, persondao{
}

4、这时springdata会自动加载personrepositoryimpl的实现类。

@test
public void testlist(){
 list<person> list = service.getlist();
 for (person p : list) {
  system.out.println(p);
 }
}

注意：xxxrepositoryimpl 与xxxrepository前面的名字必须相同，后面的也需要按照规则写，若将xxxrepositoryimpl与xxxrepository接口放在同意包下，xxxrepositoryimpl不需要添加@repository注解，但是当xxxrepositoryimpl与xxxrepository接口不在同一包下，需要在在xxxrepositoryimpl类上加repository注解进行修饰

二、添加全局repository

1、声明一个接口, 在该接口中声明需要自定义的方法, 且该接口需要继承 spring data 的 repository。

@norepositorybean
public interface baserepository<t, id extends serializable> 
 extends jparepository<t, id> { 
 public void helloworld();
}

注意：全局的扩展实现类不要用 imp 作为后缀名, 或为全局扩展接口添加 @norepositorybean 注解告知 spring data: spring data 不把其作为 repository

2、提供baserepository所声明的接口的实现类. 且继承 simplejparepository, 并提供方法的实现。

public class baserepositoryimpl<t, id extends serializable> 
 extends simplejparepository<t, id>
 implements baserepository<t, id> {
 private entitymanager em;
 public baserepositoryimpl(class<t> domainclass, entitymanager em) {
  super(domainclass, em);
  this.em = em;
 }
 @override
 public void helloworld() {
  system.out.println("helloworld");
 }
}

3、定义 jparepositoryfactorybean 的实现类, 使其生成baserepository 定义的接口实现类的对象。

public class baserepositoryfactorybean<r extends jparepository<t, i>, t, i extends serializable>
  extends jparepositoryfactorybean<r, t, i> {
 
 public baserepositoryfactorybean(class<? extends r> repositoryinterface) {
  super(repositoryinterface);
 }
 @override
 protected repositoryfactorysupport createrepositoryfactory(entitymanager entitymanager) {
  return new myrepositoryfactory(entitymanager);
 }
 
 public static class myrepositoryfactory<t, i extends serializable>
   extends jparepositoryfactory {
 
  private final entitymanager em;
  
  public myrepositoryfactory(entitymanager entitymanager) {
   super(entitymanager);
   this.em = entitymanager;
  }
  
  @override
  protected object gettargetrepository(repositoryinformation information) {
   return new baserepositoryimpl<t, i>((class<t>) information.getdomaintype(), em);
  }
  
  @override
  protected class<?> getrepositorybaseclass(repositorymetadata metadata) {
   return baserepositoryimpl.class;
  }
 }
}

4、修改 <jpa:repositories /> 节点的 factory-class 属性指向baserepositoryfactorybean的全类名。

<jpa:repositories base-package="com.znsd.springdata.dao" 
  entity-manager-factory-ref="entitymanagerfactory" 
  transaction-manager-ref="txmanager" 
  factory-class="com.znsd.springdata.dao.baserepositoryfactorybean" />

5、使用自定义的baserepository接口。

public interface studentrepository extends baserepository<student, integer>{
}

继承jpa repository 写自定义方法查询

今天在写jpa查询的时候，遇到了添加自定义方法，项目启动报错原因，现总结如下：

首先定义实体类

@entity
@table(name = "user")
class user{
     @id
    @generatedvalue 
      int id；
      @column
      string age；
      @column
      string school；
      @column
      string username；
  set，get方法 （省略）
}

public interface userrepository extends jparepository<user, long> {
      list<user> findbyusernamelike(string username);
     list<user> aaa();
}

启动项目时，项目报错提示信息为：org.springframework.data.mapping.propertyreferenceexception: no property aaa found for type com.fpi.safety.common.entity.po.user

再将list<user> aaa();方法去掉后，项目又可以正常启动运行

是什么原因呢？

经查找，原来是继承jpa，必须满足一些规则，规则如下

spring data jpa框架在进行方法名解析时，会先把方法名多余的前缀截取掉，比如find，findby，read，readby，get，getby，然后对剩下的部分进行解析。

假如创建如下的查询：findbyusername（），框架在解析该方法时，首先剔除findby，然后对剩下的属性进行解析，假设查询实体为user

1：先判断username（根据pojo规范，首字母变为小写）是否为查询实体的一个属性，如果是，则表示根据该属性进行查询;如果没有该属性，继续第二步;

2：从右往左截取第一个大写字母开头的字符串此处是name），然后检查剩下的字符串是否为查询实体的一个属性，如果是，则表示根据该属性进行查询;如果没有该属性，则重复第二步，继续从右往左截取;最后假设用户为查询实体的一个属性;

3：接着处理剩下部分（username），先判断用户所对应的类型是否有username属性，如果有，则表示该方法最终是根据“user.username”的取值进行查询;否则继续按照步骤2的规则从右往左截取，最终表示根据“user.username”的值进行查询。

4：可能会存在一种特殊情况，比如user包含一个的属性，也有一个usernamechange属性，此时会存在混合。可以明确在属性之间加上“_”以显式表达意思，比如“findbyuser_namechange ）“或者”findbyusername_change（）“

从上面，我们可以得知，jap在解析是，aaa在user类中是没有属性的，所以报错no property aaa found.

• 如果我们想要使用jap框架，又不想再多增加一个自定义类，则必须符合其命名规则
• 如果，你记不住jpa的规则也没关系，你可以自己再多写一个类来实现自定义查询方法

如下：

1. 自定义一个接口，该接口用来声明自己额外定义的查询。

public interface useerrepositorytwo {
    public list<user> searchuser(string name, int id);
}

2. 创建一个接口，该接口 extends jparepository 或者 curdrepository， 以及上面自己定义的接口 useerrepositorytwo

public interface userrepositorytwoservice extends crudrepository<logdto, integer>, customizedlogrepository {
}

3. 实现userrepositorytwoservice

注意此处的类名，必须以 2 中创建的接口的名字userrepositorytwoservice，后面加上 impl 来声明，而不是写成 useerrepositorytwoimpl

public class userrepositorytwoserviceimpl implements userrepositorytwoservice {
    @autowired
    @persistencecontext
    private entitymanager entitymanager;
    @override
    public list<user> searchlogs(int id, string name) {
        ......
    }
}

自己在写自定义实现即可

以上为个人经验，希望能给大家一个参考，也希望大家多多支持。