Springデータ – リポジトリにカスタムメソッドを追加する

投稿日: 2019-11-05 2019-11-05
タグ: JPA, MongoDB, repository, Spring Data

この記事では、Spring Data JPA
CrudRepository`とMongoDB
MongoRepository`にカスタムメソッドを追加する方法を説明します。

1. CrudRepository

1.1 `CustomerRepository`を見直し、このリポジトリにカスタムメソッドを追加します。

CustomerRepository.java

package com.mkyong.dao;

import com.mkyong.model.Customer;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.CrudRepository;
import org.springframework.data.repository.query.Param;

import java.util.Date;
import java.util.List;
import java.util.stream.Stream;

public interface CustomerRepository extends CrudRepository<Customer, Long> {

    List<Customer> findByEmail(String email);

    @Query("select c from Customer c where c.email = :email")
    Stream<Customer> findByEmailReturnStream(@Param("email") String email);

   //I have a complicated logic, no idea how to implement with @Query ...
}

1.2インターフェースを作成する。

CustomerRepositoryCustomAbc.java

package com.mkyong.dao;

import com.mkyong.model.Customer;

import java.util.List;

public interface CustomerRepositoryCustomAbc {

    List<Customer> findByAVeryComplicatedQuery(Long id, String name, String address);

}

1.3実装クラスの場合、クラス名は非常に厳しいので、 “コアリポジトリインタフェースImpl”パターンに従う必要があります。このパターンに従わないと、「Springプロパティが見つかりません」というエラーメッセージが表示されます。

CustomerRepositoryImpl.java

package com.mkyong.dao;

import com.mkyong.model.Customer;

import java.util.List;

public class CustomerRepositoryImpl implements CustomerRepositoryCustomAbc {

    @Override
    public List<Customer> findByAVeryComplicatedQuery(Long id, String name, String address) {

       //...

    }
}

1.4新しいCustomerRepositoryCustomAbcインタフェースを拡張するために、 `CustomerRepository`を更新します。

CustomerRepository.java

package com.mkyong.dao;

import com.mkyong.model.Customer;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.CrudRepository;
import org.springframework.data.repository.query.Param;

import java.util.Date;
import java.util.List;
import java.util.stream.Stream;

public interface CustomerRepository extends CrudRepository<Customer, Long>, CustomerRepositoryCustomAbc{

  //...

}

完了しました。

2. MongoRepository

2.1「MongoRepository」に新しい「特定のフィールドを更新する」メソッドを追加する別の例

DomainRepository.java

package com.mkyong.domain;

import org.springframework.data.mongodb.repository.MongoRepository;
import org.springframework.data.mongodb.repository.Query;

import java.util.List;

public interface DomainRepository extends MongoRepository<Domain, Long> {

    Domain findByDomainAndIP(String domain, String ip);

    @Query("{domain: { $regex: ?0 } })")
    List<Domain> findCustomByRegExDomain(String domain);

   //how to update a particular field? save() is not what I want.
}

2.2カスタムインターフェイス。

DomainRepositoryCustomAnyName.java

package com.mkyong.domain;

public interface DomainRepositoryCustomAnyName {

    int updateDomainDisplayFlagOnly(String domain, boolean flag);

}

2.3カスタム実装。

DomainRepositoryImpl.java

package com.mkyong.domain;

import com.mongodb.WriteResult;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.data.mongodb.core.query.Criteria;
import org.springframework.data.mongodb.core.query.Query;
import org.springframework.data.mongodb.core.query.Update;
//Impl postfix of the name on it compared to the core repository interface
public class DomainRepositoryImpl implements DomainRepositoryCustomAnyName {

    @Autowired
    MongoTemplate mongoTemplate;

    @Override
    public int updateDomainDisplayFlagOnly(String domain, boolean flag) {

        Query query = new Query(Criteria.where("domain").is(domain));
        Update update = new Update();
        update.set("display", flag);

        WriteResult result = mongoTemplate.updateFirst(query, update, Domain.class);

        if(result!=null)
            return result.getN();
        else
            return 0;

    }
}

2.4新しいカスタムインターフェース「DomainRepositoryCustomAnyName`」を拡張するために `DomainRepository`を更新しました。

DomainRepository.java

package com.mkyong.domain;

import org.springframework.data.mongodb.repository.MongoRepository;
import org.springframework.data.mongodb.repository.Query;

import java.util.List;

public interface DomainRepository extends MongoRepository<Domain, Long>, DomainRepositoryCustomAnyName {

   //...

}

完了しました。

参考文献

http://docs.spring.io/spring-data/data-document/docs/current/reference/html/#repositories.custom-implementations

[Spring

データ – カスタム実装]。リンク://spring-boot/spring-boot-spring-data-mongodb-example/[Spring

ブート – 春のデータMongoDBの例]

jpa

mongodb

リポジトリ


spring-data

getdocs

13036