Merge pull request #263 from jeffgbutler/general-mappers

Add Common MyBatis Mappers for CRUD Operations

Author: jeffgbutler

CHANGELOG.md

@@ -14,6 +14,7 @@ GitHub milestone: [https://github.com/mybatis/mybatis-dynamic-sql/issues?q=miles
 
 - Added a callback capability to the "In" conditions that will be called before rendering when the conditions are empty. Also, removed the option that forced the library to render invalid SQL in that case. ([#241](https://github.com/mybatis/mybatis-dynamic-sql/pull/241))
 - Added a utility mapper for MyBatis that allows you to run any select query without having to predefine a result mapping. ([#255](https://github.com/mybatis/mybatis-dynamic-sql/pull/255))
+- Added utility mappers for MyBatis that allow you to run generic CRUD operations. ([#263](https://github.com/mybatis/mybatis-dynamic-sql/pull/263))
 
 ## Release 1.2.0 - August 19, 2020
 

checkstyle-override.xml

@@ -17,8 +17,8 @@
 
 -->
 <!DOCTYPE module PUBLIC
-          "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
-          "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
+        "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+        "https://checkstyle.org/dtds/configuration_1_3.dtd">
 
 <!--
     Checkstyle configuration that checks the Google coding conventions from Google Java Style

pom.xml

@@ -201,18 +201,21 @@
       <artifactId>kotlin-stdlib-jdk8</artifactId>
       <version>${kotlin.version}</version>
       <scope>provided</scope>
+      <optional>true</optional>
     </dependency>
     <dependency>
       <groupId>org.springframework</groupId>
       <artifactId>spring-jdbc</artifactId>
       <version>5.2.9.RELEASE</version>
       <scope>provided</scope>
+      <optional>true</optional>
     </dependency>
     <dependency>
       <groupId>org.mybatis</groupId>
       <artifactId>mybatis</artifactId>
       <version>3.5.5</version>
       <scope>provided</scope>
+      <optional>true</optional>
     </dependency>
 
     <dependency>

src/main/java/org/mybatis/dynamic/sql/util/mybatis3/CommonCountMapper.java

@@ -0,0 +1,40 @@
+/*
+ *    Copyright 2016-2020 the original author or authors.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+package org.mybatis.dynamic.sql.util.mybatis3;
+
+import org.apache.ibatis.annotations.SelectProvider;
+import org.mybatis.dynamic.sql.select.render.SelectStatementProvider;
+import org.mybatis.dynamic.sql.util.SqlProviderAdapter;
+
+/**
+ * This is a general purpose MyBatis mapper for count statements. Count statements are select statements that always
+ * return a long.
+ *
+ * <p>This mapper can be injected as-is into a MyBatis configuration, or it can be extended with existing mappers.
+ *
+ * @author Jeff Butler
+ */
+public interface CommonCountMapper {
+    /**
+     * Execute a select statement that returns a long (typically a select(count(*)) statement). This mapper
+     * assumes the statement returns a single row with a single column that cen be retrieved as a long.
+     *
+     * @param selectStatement the select statement
+     * @return the long value
+     */
+    @SelectProvider(type = SqlProviderAdapter.class, method = "select")
+    long count(SelectStatementProvider selectStatement);
+}

src/main/java/org/mybatis/dynamic/sql/util/mybatis3/CommonDeleteMapper.java

@@ -0,0 +1,38 @@
+/*
+ *    Copyright 2016-2020 the original author or authors.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+package org.mybatis.dynamic.sql.util.mybatis3;
+
+import org.apache.ibatis.annotations.DeleteProvider;
+import org.mybatis.dynamic.sql.delete.render.DeleteStatementProvider;
+import org.mybatis.dynamic.sql.util.SqlProviderAdapter;
+
+/**
+ * This is a general purpose MyBatis mapper for delete statements.
+ *
+ * <p>This mapper can be injected as-is into a MyBatis configuration, or it can be extended with existing mappers.
+ *
+ * @author Jeff Butler
+ */
+public interface CommonDeleteMapper {
+    /**
+     * Execute a delete statement.
+     *
+     * @param deleteStatement the delete statement
+     * @return the number of rows affected
+     */
+    @DeleteProvider(type = SqlProviderAdapter.class, method = "delete")
+    int delete(DeleteStatementProvider deleteStatement);
+}

src/main/java/org/mybatis/dynamic/sql/util/mybatis3/CommonInsertMapper.java

@@ -0,0 +1,67 @@
+/*
+ *    Copyright 2016-2020 the original author or authors.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+package org.mybatis.dynamic.sql.util.mybatis3;
+
+import org.apache.ibatis.annotations.InsertProvider;
+import org.mybatis.dynamic.sql.insert.render.GeneralInsertStatementProvider;
+import org.mybatis.dynamic.sql.insert.render.InsertSelectStatementProvider;
+import org.mybatis.dynamic.sql.insert.render.InsertStatementProvider;
+import org.mybatis.dynamic.sql.insert.render.MultiRowInsertStatementProvider;
+import org.mybatis.dynamic.sql.util.SqlProviderAdapter;
+
+/**
+ * This is a general purpose mapper for executing various types of insert statement.
+ *
+ * @param <T> the type of record associated with this mapper
+ */
+public interface CommonInsertMapper<T> {
+    /**
+     * Execute an insert statement with input fields mapped to values in a POJO.
+     *
+     * @param insertStatement the insert statement
+     * @return the number of rows affected
+     */
+    @InsertProvider(type = SqlProviderAdapter.class, method = "insert")
+    int insert(InsertStatementProvider<T> insertStatement);
+
+    /**
+     * Execute an insert statement with input fields supplied directly.
+     *
+     * @param insertStatement the insert statement
+     * @return the number of rows affected
+     */
+    @InsertProvider(type = SqlProviderAdapter.class, method = "generalInsert")
+    int generalInsert(GeneralInsertStatementProvider insertStatement);
+
+    /**
+     * Execute an insert statement with input fields supplied by a select statement.
+     *
+     * @param insertSelectStatement the insert statement
+     * @return the number of rows affected
+     */
+    @InsertProvider(type = SqlProviderAdapter.class, method = "insertSelect")
+    int insertSelect(InsertSelectStatementProvider insertSelectStatement);
+
+    /**
+     * Execute an insert statement that inserts multiple rows. The row values are supplied by mapping
+     * to values in a List of POJOs.
+     *
+     * @param insertStatement the insert statement
+     * @return the number of rows affected
+     */
+    @InsertProvider(type = SqlProviderAdapter.class, method = "insertMultiple")
+    int insertMultiple(MultiRowInsertStatementProvider<T> insertStatement);
+}

src/main/java/org/mybatis/dynamic/sql/util/mybatis3/GeneralMapper.java renamed to src/main/java/org/mybatis/dynamic/sql/util/mybatis3/CommonSelectMapper.java

@@ -27,8 +27,8 @@
 import org.mybatis.dynamic.sql.util.SqlProviderAdapter;
 
 /**
- * This is a general purpose MyBatis mapper. It allows you to execute select statements without having to
- * write a custom {@link org.apache.ibatis.annotations.ResultMap} for each statement.
+ * This is a general purpose MyBatis mapper for select statements. It allows you to execute select statements without
+ * having to write a custom {@link org.apache.ibatis.annotations.ResultMap} for each statement.
  *
  * <p>This mapper contains three types of methods:
  * <ul>
@@ -46,7 +46,7 @@
  *
  * @author Jeff Butler
  */
-public interface GeneralMapper {
+public interface CommonSelectMapper {
     /**
      * Select a single row as a Map of values. The row may have any number of columns.
      * The Map key will be the column name as returned from the
@@ -67,7 +67,7 @@ public interface GeneralMapper {
      * the row values into a Map, and then a row mapper can retrieve values from the Map and use them
      * to construct a custom object.
      *
-     * <p>See {@link GeneralMapper#selectOneMappedRow(SelectStatementProvider)} for details about
+     * <p>See {@link CommonSelectMapper#selectOneMappedRow(SelectStatementProvider)} for details about
      * how MyBatis will construct the Map of values.
      *
      * @param selectStatement the select statement

src/main/java/org/mybatis/dynamic/sql/util/mybatis3/CommonUpdateMapper.java

@@ -0,0 +1,38 @@
+/*
+ *    Copyright 2016-2020 the original author or authors.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+package org.mybatis.dynamic.sql.util.mybatis3;
+
+import org.apache.ibatis.annotations.UpdateProvider;
+import org.mybatis.dynamic.sql.update.render.UpdateStatementProvider;
+import org.mybatis.dynamic.sql.util.SqlProviderAdapter;
+
+/**
+ * This is a general purpose MyBatis mapper for update statements.
+ *
+ * <p>This mapper can be injected as-is into a MyBatis configuration, or it can be extended with existing mappers.
+ *
+ * @author Jeff Butler
+ */
+public interface CommonUpdateMapper {
+    /**
+     * Execute an update statement.
+     *
+     * @param updateStatement the update statement
+     * @return the number of rows affected
+     */
+    @UpdateProvider(type = SqlProviderAdapter.class, method = "update")
+    int update(UpdateStatementProvider updateStatement);
+}