使用带有@RequestParam的spring-boot内部@Controllers来提供搜索方法

时间:2017-04-25 10:57:24

标签: java rest spring-boot spring-data-jpa spring-data-rest

我正在建造一个带弹簧靴的后端休息api。

实体:

@Entity
public class Club {

    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private long id;

    @NotNull
    @Column(unique=true)
    private String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

}

存储库:

@RepositoryRestResource
public interface ClubRepository extends JpaRepository<Club, Long>, JpaSpecificationExecutor<Club> {

}

仅在http://host/clubs公开了一个休息终点,很棒。现在,我想在网址中允许一些参数用于搜索目的,因此我开始按照http://www.baeldung.com/rest-api-search-language-spring-data-specifications的说明进行操作。

但他们最终会创建一个自定义@Controller来传递请求参数:

@Controller
public class ClubController {

    @Autowired
    private ClubRepository repo;

    @RequestMapping(method = RequestMethod.GET, value = "/clubs")
    @ResponseBody
    public List<Club> search(@RequestParam(value = "search") String search) {
        /* ... */
        return repo.findAll(spec);
    }
}

所以你看,他们最终调用了存储库的findAll方法,只是传递了他们根据查询参数构建的规范。很容易,但我真的很想不必为每个域对象创建额外的控制器。换句话说,有没有办法通过直接注释(例如)存储库中的@Entity或覆盖方法(如findAll方法)来提供此搜索功能?

1 个答案:

答案 0 :(得分:2)

更好的方法是使用QueryDsl而不是标准API。 Spring Data和Spring Data Rest将为您提供许多优秀的“免费”功能,而不是一些基本配置。

https://spring.io/blog/2015/09/04/what-s-new-in-spring-data-release-gosling#spring-data-rest

https://spring.io/blog/2011/04/26/advanced-spring-data-jpa-specifications-and-querydsl/

一个已配置的存储库界面变为:

@RepositoryRestResource
public interface ClubRepository extends JpaRepository<Club, Long>, QueryDslPredicateExecutor<Club> {

}

然后可以使用动态的参数组合查询端点:

e.g。

http://host/clubs?name=someName

http://host/clubs?name=someName&otherProperty=X&sort=name,desc

不需要进一步的代码,即没有自定义控制器,没有规范和查询方法。

要配置Maven,只需将以下内容添加到包含实体的模块中的POM:这将生成必要的“查询”类。

<dependencies>
    <dependency>
        <groupId>com.querydsl</groupId>
        <artifactId>querydsl-jpa</artifactId>
        <version>${querydsl.version}</version>
    </dependency>
    <dependency>
        <groupId>com.querydsl</groupId>
        <artifactId>querydsl-apt</artifactId>
        <version>${querydsl.version}</version>
        <scope>compile</scope>
    </dependency>
</dependencies>

<build>
    <plugins>
        <plugin>
            <groupId>com.mysema.maven</groupId>
            <artifactId>apt-maven-plugin</artifactId>
            <version>1.1.3</version>
            <executions>
                <execution>
                    <goals>
                        <goal>process</goal>
                    </goals>
                    <configuration>
                        <outputDirectory>target/generated-sources/java</outputDirectory>
                        <processor>com.querydsl.apt.jpa.JPAAnnotationProcessor</processor>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>