{"id":19032735,"url":"https://github.com/joutvhu/spring-dynamic-jpa","last_synced_at":"2025-04-15T21:23:08.747Z","repository":{"id":38311780,"uuid":"293973061","full_name":"joutvhu/spring-dynamic-jpa","owner":"joutvhu","description":"The Spring Dynamic JPA will make it easy to implement dynamic queries with JpaRepository.","archived":false,"fork":false,"pushed_at":"2024-05-14T14:26:43.000Z","size":330,"stargazers_count":27,"open_issues_count":0,"forks_count":11,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-29T01:24:01.661Z","etag":null,"topics":["annotation","dynamic-queries","dynamic-query","jpa","jpa-dynamic-query","jparepository","query-template","spring","spring-boot","spring-data-jpa","spring-dynamic-jpa"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/joutvhu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["joutvhu"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["https://paypal.me/joutvhu","https://buymeacoffee.com/joutvhu"]}},"created_at":"2020-09-09T01:48:18.000Z","updated_at":"2024-12-30T12:09:15.000Z","dependencies_parsed_at":"2024-05-14T14:55:30.868Z","dependency_job_id":"908c33b3-3099-4f37-bbf9-058031b4ad01","html_url":"https://github.com/joutvhu/spring-dynamic-jpa","commit_stats":null,"previous_names":[],"tags_count":41,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joutvhu%2Fspring-dynamic-jpa","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joutvhu%2Fspring-dynamic-jpa/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joutvhu%2Fspring-dynamic-jpa/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joutvhu%2Fspring-dynamic-jpa/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joutvhu","download_url":"https://codeload.github.com/joutvhu/spring-dynamic-jpa/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249155022,"owners_count":21221518,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["annotation","dynamic-queries","dynamic-query","jpa","jpa-dynamic-query","jparepository","query-template","spring","spring-boot","spring-data-jpa","spring-dynamic-jpa"],"created_at":"2024-11-08T21:30:45.796Z","updated_at":"2025-04-15T21:23:08.715Z","avatar_url":"https://github.com/joutvhu.png","language":"Java","funding_links":["https://github.com/sponsors/joutvhu","https://paypal.me/joutvhu","https://buymeacoffee.com/joutvhu"],"categories":[],"sub_categories":[],"readme":"# Spring Dynamic JPA\n\nThe Spring Dynamic JPA will make it easy to implement dynamic queries with JpaRepository.\n\n## How to use?\n\n### Install dependency\n\n```groovy\nimplementation 'com.github.joutvhu:spring-dynamic-jpa:3.1.8'\n```\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.joutvhu\u003c/groupId\u003e\n    \u003cartifactId\u003espring-dynamic-jpa\u003c/artifactId\u003e\n    \u003cversion\u003e3.1.8\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n- Please choose the _Spring Dynamic JPA_ version appropriate with your spring version.\n\n  | Spring Boot version | Spring Dynamic JPA version |\n  |:-------------------:|:--------------------------:|\n  |    2.0.x.RELEASE    |           2.0.8            |\n  |    2.1.x.RELEASE    |           2.1.8            |\n  |    2.2.x.RELEASE    |           2.2.8            |\n  |    2.3.x.RELEASE    |           2.3.8            |\n  |        2.4.x        |           2.3.8            |\n  |        2.5.x        |           2.3.8            |\n  |        2.6.x        |           2.3.8            |\n  |        2.7.x        |           2.7.8            |\n  |        3.0.x        |           3.0.8            |\n  |        3.1.x        |           3.1.8            |\n  |        3.2.x        |           3.1.8            |\n\nAlso, you have to choose a [Dynamic Query Template Provider](https://github.com/joutvhu/spring-dynamic-commons#dynamic-query-template-provider) to use,\nthe Dynamic Query Template Provider will decide the style you write dynamic query template.\n\nIn this document, I will use [Spring Dynamic Freemarker](https://github.com/joutvhu/spring-dynamic-freemarker).\nIf you migrated from a lower version, you should use it.\n\n```groovy\nimplementation 'com.github.joutvhu:spring-dynamic-freemarker:1.0.1'\n```\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.joutvhu\u003c/groupId\u003e\n    \u003cartifactId\u003espring-dynamic-freemarker\u003c/artifactId\u003e\n    \u003cversion\u003e1.0.1\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n### Configuration\n\n- First you need to create a bean of `DynamicQueryTemplateProvider`, that depending on which the Dynamic Query Template Provider you are using.\n\n```java\n@Bean\npublic DynamicQueryTemplateProvider dynamicQueryTemplateProvider() {\n    FreemarkerQueryTemplateProvider provider = new FreemarkerQueryTemplateProvider();\n    provider.setTemplateLocation(\"classpath:/query\");\n    provider.setSuffix(\".dsql\");\n    return provider;\n}\n```\n\n- Next, you need to set the jpa repository's `repositoryFactoryBeanClass` property to `DynamicJpaRepositoryFactoryBean.class`.\n\n```java\n// Config with annotation\n@EnableJpaRepositories(repositoryFactoryBeanClass = DynamicJpaRepositoryFactoryBean.class)\n```\n\n```xml\n\u003c!-- Config with xml --\u003e\n\u003cjpa:repositories repository-factory-bean-class=\"com.joutvhu.dynamic.jpa.support.DynamicJpaRepositoryFactoryBean\"/\u003e\n```\n\n### Dynamic query\n\n- Methods annotated with `@DynamicQuery` tells `DynamicJpaQueryLookupStrategy` to know the content of the query is query template. It needs to parse the query template to query string before executing the query.\n\n```java\npublic interface UserRepository extends JpaRepository\u003cUser, Long\u003e {\n    @DynamicQuery(\n        value = \"select t from User t where t.firstName = :firstName\\n\" +\n            \"\u003c#if lastName?has_content\u003e\\n\" +\n            \"  and t.lastName = :lastName\\n\" +\n            \"\u003c/#if\u003e\"\n    )\n    List\u003cUser\u003e findUserByNames(Long firstName, String lastName);\n\n    @Query(value = \"select t from User t where t.firstName = :firstName\")\n    List\u003cUser\u003e findByFirstName(String firstName);\n\n    List\u003cUser\u003e findByLastName(String lastName);\n\n    @DynamicQuery(\n        value = \"select USER_ID from USER\\n\" +\n            \"\u003c#if name??\u003e\\n\" +\n            \"  where concat(FIRST_NAME, ' ', LAST_NAME) like %:name%\\n\" +\n            \"\u003c/#if\u003e\",\n        nativeQuery = true\n    )\n    List\u003cLong\u003e searchIdsByName(String name);\n\n    @DynamicQuery(\n        value = \"select t from User t\\n\" +\n            \"\u003c#if role??\u003e\\n\" +\n            \"  where t.role = :role\\n\" +\n            \"\u003c/#if\u003e\",\n        countQuery = \"select count(t) from User t\\n\" +\n            \"\u003c#if role??\u003e\\n\" +\n            \"  where t.role = :role\\n\" +\n            \"\u003c/#if\u003e\"\n    )\n    Page\u003cUser\u003e findByRole(String role, Pageable pageable);\n}\n```\n\n### Load query template files\n\n- If you do not specify the query template on the `@DynamicQuery` annotation.\n  The `DynamicQueryTemplateProvider` will find them from external template files based on the `TemplateLocation` and `Suffix` that you specify in the provider.\n\n- If you don't want to load the template from external template files you can use the following code `provider.setSuffix(null);`.\n\n- Each template will start with a template name definition line. The template name definition line must be start with two dash characters (`--`). The template name will have the following syntax.\n\n  ```\n  queryMethodName[.queryType]\n  ```\n\n  - `queryMethodName` can be provided through field `@DynamicQuery.name`. If `@DynamicQuery.name` is not provided, `queryMethodName` will be `entityName:methodName` where `entityName` is entity class name, `methodName` is query method name\n\n  - `queryType`  corresponds to what query type of `@DynamicQuery` annotation.\n\n  | queryType | DynamicQuery field |\n  |:----------:|:-------------:|\n  | empty |  DynamicQuery.value |\n  | \"count\" |  DynamicQuery.countQuery |\n  | \"projection\" |  DynamicQuery.countProjection |\n\n- Query templates (Ex: `resoucers/query/user-query.dsql`) \n\n```sql\n--User:findUserByNames\nselect t from User t where t.firstName = :firstName\n\u003c#if lastName?has_content\u003e\n  and t.lastName = :lastName\n\u003c/#if\u003e\n\n-- User:searchIdsByName\nselect USER_ID from USER\n\u003c#if name??\u003e\n  where concat(FIRST_NAME, ' ', LAST_NAME) like %:name%\n\u003c/#if\u003e\n\n-- User:findByRole\nselect t from User t\n\u003c#if role??\u003e\n  where t.role = :role\n\u003c/#if\u003e\n\n-- User:findByRole.count\nselect count(t) from User t\n\u003c#if role??\u003e\n  where t.role = :role\n\u003c/#if\u003e\n\n-- User:findByGroup\nselect t from User t\n\u003c#if group.name?starts_with(\"Git\")\u003e\n  where t.groupId = :#{#group.id}\n\u003c/#if\u003e\n\n-- get_user_by_username_and_email\nselect t from User t\n\u003c@where\u003e\n  \u003c#if username??\u003e\n    and t.username = :username\n  \u003c/#if\u003e\n  \u003c#if email??\u003e\n    and t.email = :email\n  \u003c/#if\u003e\n\u003c/@where\u003e\n```\n\n- Now you don't need to specify the query template on `@DynamicQuery` annotation.\n\n```java\npublic interface UserRepository extends JpaRepository\u003cUser, Long\u003e {\n    @DynamicQuery\n    List\u003cUser\u003e findUserByNames(Long firstName, String lastName);\n\n    @Query(value = \"select t from User t where t.firstName = :firstName\")\n    List\u003cUser\u003e findByFirstName(String firstName);\n\n    List\u003cUser\u003e findByLastName(String lastName);\n\n    @DynamicQuery(nativeQuery = true)\n    List\u003cLong\u003e searchIdsByName(String name);\n\n    @DynamicQuery\n    Page\u003cUser\u003e findByRole(String role, Pageable pageable);\n\n    @DynamicQuery\n    List\u003cUser\u003e findByGroup(Group group);\n\n    @DynamicQuery(name = \"get_user_by_username_and_email\")\n    List\u003cUser\u003e getUserWithUsernameAndEmail(String username, String email);\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoutvhu%2Fspring-dynamic-jpa","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoutvhu%2Fspring-dynamic-jpa","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoutvhu%2Fspring-dynamic-jpa/lists"}