{"id":15196885,"url":"https://github.com/naver/spring-jdbc-plus","last_synced_at":"2025-04-08T11:13:07.523Z","repository":{"id":37440999,"uuid":"233731825","full_name":"naver/spring-jdbc-plus","owner":"naver","description":"Spring JDBC Plus","archived":false,"fork":false,"pushed_at":"2025-03-25T05:35:35.000Z","size":911,"stargazers_count":280,"open_issues_count":8,"forks_count":34,"subscribers_count":18,"default_branch":"main","last_synced_at":"2025-04-01T10:07:47.391Z","etag":null,"topics":["jdbc","spring-data","spring-data-jdbc","spring-framework","spring-jdbc","sql"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/naver.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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}},"created_at":"2020-01-14T01:41:35.000Z","updated_at":"2025-03-25T05:29:53.000Z","dependencies_parsed_at":"2023-09-24T06:22:52.400Z","dependency_job_id":"ff6e9d56-4f27-4883-b677-deccd39d0fc5","html_url":"https://github.com/naver/spring-jdbc-plus","commit_stats":{"total_commits":274,"total_committers":15,"mean_commits":"18.266666666666666","dds":0.4781021897810219,"last_synced_commit":"cc9f1736747943210ff52f386b303350395a5847"},"previous_names":[],"tags_count":84,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/naver%2Fspring-jdbc-plus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/naver%2Fspring-jdbc-plus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/naver%2Fspring-jdbc-plus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/naver%2Fspring-jdbc-plus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/naver","download_url":"https://codeload.github.com/naver/spring-jdbc-plus/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247829512,"owners_count":21002997,"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":["jdbc","spring-data","spring-data-jdbc","spring-framework","spring-jdbc","sql"],"created_at":"2024-09-28T00:05:42.599Z","updated_at":"2025-04-08T11:13:07.497Z","avatar_url":"https://github.com/naver.png","language":"Java","readme":"[![GitHub release](https://img.shields.io/github/v/release/naver/spring-jdbc-plus.svg)](https://img.shields.io/github/v/release/naver/spring-jdbc-plus.svg?include_prereleases)\n[![GitHub license](https://img.shields.io/github/license/naver/spring-jdbc-plus.svg)](https://github.com/naver/spring-jdbc-plus.js/blob/master/LICENSE)\n\n# Spring JDBC Plus ![build](https://github.com/naver/spring-jdbc-plus/actions/workflows/gradle.yml/badge.svg) [![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/naver/spring-jdbc-plus) [![Project Diagrams](https://sourcespy.com/shield.svg)](https://sourcespy.com/github/naverspringjdbcplus/)\n\n**⚠️ Please do not use 3.3.3** \u003cbr\u003e\nSpring JDBC Plus provides [Spring Data JDBC](https://github.com/spring-projects/spring-data-relational) based extension.\nIt provides necessary features when writing more complex SQL than the functions supported by `CrudRepository`.\nIf you need to use Spring Data JDBC's Persistence features and SQL execution function in combination, `Spring JDBC Plus`\nmay be an appropriate choice.\n\n## Features\n\n- Support for executing custom `SQL SELECT` statements\n- Provide `BeanParameterSource`, `MapParameterSource`, `EntityParameterSource`\n- Provide parameter source converters such as `Java8Time`,`Enum`, etc.\n- Entity mapping support for complex table join SELECT results\n- `AggregateResultSet` supports mapping of `1: N` result data to `Aggregate` object graph by `LEFT OUTER JOIN` lookup\n- `JdbcRepository` provides insert / update syntax\n- Support for setting `Reactive (Flux / Mono)` type as the return type of `CustomRepository` method\n\n- [User Guide](https://github.com/naver/spring-jdbc-plus/wiki)\n\n## Getting Started (Spring Boot Starter Data JDBC Plus SQL)\n\n* Gradle\n\n    ```gradle\n    buildscript {\n        repositories {\n            mavenCentral()\n            mavenLocal()\n            maven {\n                url \"https://repo.spring.io/milestone/\"\n            }\n        }\n        dependencies {\n            classpath(\"org.springframework.boot:spring-boot-gradle-plugin:3.5.0-M1\")\n        }\n    }\n\n    dependencies {\n        implementation(\"org.springframework.boot:spring-boot-starter-data-jdbc\")\n        implementation(\"com.navercorp.spring:spring-boot-starter-data-jdbc-plus-sql:3.5.0-M1\")\n    }\n    ```\n\n* Maven\n\n    ```xml\n    \u003cparent\u003e\n        \u003cgroupId\u003eorg.springframework.boot\u003c/groupId\u003e\n        \u003cartifactId\u003espring-boot-starter-parent\u003c/artifactId\u003e\n        \u003cversion\u003e3.5.0-M1\u003c/version\u003e\n        \u003crelativePath/\u003e\n    \u003c/parent\u003e\n\n    \u003cdependency\u003e\n        \u003cgroupId\u003eorg.springframework.boot\u003c/groupId\u003e\n        \u003cartifactId\u003espring-boot-starter-data-jdbc\u003c/artifactId\u003e\n    \u003c/dependency\u003e\n\n    \u003cdependency\u003e\n        \u003cgroupId\u003ecom.navercorp.spring\u003c/groupId\u003e\n        \u003cartifactId\u003espring-boot-starter-data-jdbc-plus-sql\u003c/artifactId\u003e\n        \u003cversion\u003e3.5.0-M1\u003c/version\u003e\n    \u003c/dependency\u003e\n    ```\n\n* Java Codes\n\n    ```java\n    @Table(\"n_order\")\n    @Data\n    public class Order {\n        @Id\n        @Column(\"order_no\")\n        private Long orderNo;\n\n        @Column(\"price\")\n        private long price;\n\n        @Column(\"purchaser_no\")\n        private String purchaserNo;\n    }\n\n    public interface OrderRepository extends CrudRepository\u003cOrder, Long\u003e, OrderRepositoryCustom {\n    }\n\n    public interface OrderRepositoryCustom {\n        List\u003cOrder\u003e findByPurchaserNo(String purchaserNo);\n    }\n\n    public class OrderRepositoryImpl extends JdbcRepositorySupport\u003cOrder\u003e implements OrderRepositoryCustom {\n        private final OrderSql sqls;\n\n        public OrderRepositoryImpl(EntityJdbcProvider entityJdbcProvider) {\n            super(Order.class, entityJdbcProvider);\n            this.sql = sqls(OrderSql::new);\n        }\n\n        @Override\n        public List\u003cOrder\u003e findByPurchaserNo(String purchaserNo) {\n            String sql = this.sql.selectByPurchaserNo();\n            return find(sql, mapParameterSource()\n                .addValue(\"purchaserNo\", purchaserNo));\n        }\n    }\n    ```\n\n* Groovy codes for SQL\n\n    ```groovy\n    class OrderSql extends SqlGeneratorSupport {\n\n        String selectByPurchaserNo() {\n            \"\"\"\n            SELECT ${sql.columns(Order)}\n            FROM n_order\n            WHERE purchaser_no = :purchaserNo\n            \"\"\"\n        }\n    }\n    ```\n\n### Cautions when writing SQL\n\n- Must use named parameters to pass parameters to SQL.\n- If parameter values are concatenated directly to String, it produces bad effects.\n    - May cause SQL injection vulnerability.\n    - Reduce efficiency of caches in PreparedStatement and NamedParameterJdbcTemplate\n\nBe careful when use string interpolation in Groovy and Kotlin.\n\n* Bad  :-1:\n    ```groovy\n    class OrderSql extends SqlGeneratorSupport {\n\n        String selectByPurchaserNo(String purchaserNo) {\n        \"\"\"\n        SELECT ${sql.columns(Order)}\n        FROM n_order\n        WHERE purchaser_no = '${purchaserNo}'\n        \"\"\"\n        }\n    }\n    ```\n\n* Good :+1:\n    ```groovy\n    class OrderSql extends SqlGeneratorSupport {\n\n        String selectByPurchaserNo() {\n        \"\"\"\n        SELECT ${sql.columns(Order)}\n        FROM n_order\n        WHERE purchaser_no = :purchaserNo\n        \"\"\"\n        }\n    }\n    ```\n\n## Annotation Guide\n\n### @SqlTableAlias\n\n``` JAVA\n@Value\n@Builder\n@Table(\"post\")\npublic class PostDto {\n    @Id\n    Long id;\n\n    @Column\n    Post post;\n\n    @SqlTableAlias(\"p_labels\")\n    @MappedCollection(idColumn = \"board_id\")\n    Set\u003cLabel\u003e labels;\n}\n```\n\n`@SqlTableAlias` is used to attach a separate identifier to the table. `@SqlTableAlias` can be applied to class, field\nand method.\n\n`@SqlTableAlias` is used in the form of `@SqlTableAlias(\"value\")` .\n\n### @SqlFunction\n\n```java\n\n@SqlTableAlias(\"ts\")\nstatic class TestEntityWithNonNullValue {\n\t@Column\n\tprivate Long testerId;\n\n\t@Column(\"tester_nm\")\n\tprivate String testerName;\n\n\t@SqlFunction(expressions = {SqlFunction.COLUMN_NAME, \"0\"})\n\t@Column\n\tprivate int age;\n}\n```\n\n`@SqlFunction` is typically used to map fields or methods of entity classes to SQL functions.\n\nFor example, it can be utilized to define default values for certain fields, or to transform values based on specific\nconditions.\n\n### @SoftDeleteColumn\n\n```java\n\n@Value\n@Builder\n@Table(\"article\")\nstatic class SoftDeleteArticle {\n\t@Id\n\tLong id;\n\n\tString contents;\n\n\t@SoftDeleteColumn.Boolean(valueAsDeleted = \"true\")\n\tboolean deleted;\n}\n```\n\n`@SoftDeleteColumn` supports the soft delete, which is considered as deleted but does not delete actually.\nThis replaces the default 'DELETE' operations to 'UPDATE' operations, by updating specific columns.\n\nYou can use value types `Boolean` or `String` by Declaring `@SoftDeleteColumn.Boolean` or `@SoftDeleteColumn.String`.\n\n## Examples\n\n* [Java + Groovy SQL Example](./guide-projects/plus-sql-java-groovy-guide)\n* [Java + Kotlin SQL Example](./guide-projects/plus-sql-java-kotlin-guide)\n* [Kotlin Example](./guide-projects/plus-sql-kotlin-guide)\n\n## Getting Help\n\n- [User Guide](https://github.com/naver/spring-jdbc-plus/wiki)\n- [Reporting Issues](https://github.com/naver/spring-jdbc-plus/issues)\n\n## Coding Convention\n\n- [naver hackday-conventions-java](https://naver.github.io/hackday-conventions-java/)\n- [naver/hackday-conventions-java](https://github.com/naver/hackday-conventions-java)\n- checkstyle: ./rule/naver-checkstyle-rules.xml\n- intellij-formatter:\n  ./rule/naver-intellij-formatter.xml (https://naver.github.io/hackday-conventions-java/#editor-config)\n\n## Building from Source\n\n```\n$  ./gradlew clean build\n```\n\n## License\n\n```\n   Copyright 2020-2021 NAVER Corp.\n\n   Licensed under the Apache License, Version 2.0 (the \"License\");\n   you may not use this file except in compliance with the License.\n   You may obtain a copy of the License at\n\n       http://www.apache.org/licenses/LICENSE-2.0\n\n   Unless required by applicable law or agreed to in writing, software\n   distributed under the License is distributed on an \"AS IS\" BASIS,\n   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n   See the License for the specific language governing permissions and\n   limitations under the License.\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnaver%2Fspring-jdbc-plus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnaver%2Fspring-jdbc-plus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnaver%2Fspring-jdbc-plus/lists"}