Refactor the SQL statements splicing, use the array attaching for Str…

…ing params
ctripcorp · Apr 19, 2024 · b4ac6e3 · b4ac6e3
1 parent c594567
commit b4ac6e3
Show file tree

Hide file tree

Showing 40 changed files with 206 additions and 198 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,26 @@
 
 - Date format: YYYY-MM-dd
 
+## v1.3.0 / 2024-04-16
+
+### All
+
+* Update `Kotlin`'s version to `1.9.23`
+
+### sqllin-dsl
+
+* Update `kotlinx.coroutines`'s version to `1.8.0`
+* Update `kotlinx.serialization`'s version to `1.6.3`
+* Modified the SQL statements' splicing method, that fixed the [issue#77](https://github.com/ctripcorp/SQLlin/issues/77) that users can't read/write special symbols as the values in SQL statements.
+
+### sqllin-driver
+
+* Update the `sqlite-jdbc`'s version to `3.45.3.0`
+
+### sqllin-processor
+
+* Update `KSP`'s version to `1.9.23-1.0.20`
+
 ## v1.2.4 / 2024-01-05
 
 ### All

diff --git a/gradle.properties b/gradle.properties
@@ -1,10 +1,10 @@
-VERSION=1.2.4
+VERSION=1.3.0
 GROUP=com.ctrip.kotlin
 
-kotlinVersion=1.9.22
-kspVersion=1.9.22-1.0.16
-serializationVersion=1.6.2
-coroutinesVersion=1.7.3
+kotlinVersion=1.9.23
+kspVersion=1.9.23-1.0.20
+serializationVersion=1.6.3
+coroutinesVersion=1.8.0
 androidxAnnotationVersion=1.7.1
 
 #Maven Publish Information

diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,6 @@
 #Tue Mar 08 15:11:46 CST 2022
 distributionBase=GRADLE_USER_HOME
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
 distributionPath=wrapper/dists
 zipStorePath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
diff --git a/sqllin-driver/build.gradle.kts b/sqllin-driver/build.gradle.kts
@@ -95,7 +95,7 @@ kotlin {
 
         val jvmMain by getting {
             dependencies {
-                implementation("org.xerial:sqlite-jdbc:3.44.1.0")
+                implementation("org.xerial:sqlite-jdbc:3.45.3.0")
             }
         }
     }

diff --git a/sqllin-driver/src/androidMain/kotlin/com/ctrip/sqllin/driver/AndroidDatabaseConnection.kt b/sqllin-driver/src/androidMain/kotlin/com/ctrip/sqllin/driver/AndroidDatabaseConnection.kt
@@ -25,17 +25,17 @@ import android.database.sqlite.SQLiteDatabase
 
 internal class AndroidDatabaseConnection(private val database: SQLiteDatabase) : DatabaseConnection {
 
-    override fun execSQL(sql: String, bindParams: Array<Any?>?) =
+    override fun execSQL(sql: String, bindParams: Array<out Any?>?) =
         if (bindParams == null)
             database.execSQL(sql)
         else
             database.execSQL(sql, bindParams)
 
-    override fun executeInsert(sql: String, bindParams: Array<Any?>?) = execSQL(sql, bindParams)
+    override fun executeInsert(sql: String, bindParams: Array<out Any?>?) = execSQL(sql, bindParams)
 
-    override fun executeUpdateDelete(sql: String, bindParams: Array<Any?>?) = execSQL(sql, bindParams)
+    override fun executeUpdateDelete(sql: String, bindParams: Array<out Any?>?) = execSQL(sql, bindParams)
 
-    override fun query(sql: String, bindParams: Array<String?>?): CommonCursor = AndroidCursor(database.rawQuery(sql, bindParams))
+    override fun query(sql: String, bindParams: Array<out String?>?): CommonCursor = AndroidCursor(database.rawQuery(sql, bindParams))
 
     override fun beginTransaction() = database.beginTransaction()
     override fun endTransaction() = database.endTransaction()

diff --git a/sqllin-driver/src/commonMain/kotlin/com/ctrip/sqllin/driver/DatabaseConnection.kt b/sqllin-driver/src/commonMain/kotlin/com/ctrip/sqllin/driver/DatabaseConnection.kt
@@ -23,11 +23,11 @@ package com.ctrip.sqllin.driver
 
 public interface DatabaseConnection {
 
-    public fun execSQL(sql: String, bindParams: Array<Any?>? = null)
-    public fun executeInsert(sql: String, bindParams: Array<Any?>? = null)
-    public fun executeUpdateDelete(sql: String, bindParams: Array<Any?>? = null)
+    public fun execSQL(sql: String, bindParams: Array<out Any?>? = null)
+    public fun executeInsert(sql: String, bindParams: Array<out Any?>? = null)
+    public fun executeUpdateDelete(sql: String, bindParams: Array<out Any?>? = null)
 
-    public fun query(sql: String, bindParams: Array<String?>? = null): CommonCursor
+    public fun query(sql: String, bindParams: Array<out String?>? = null): CommonCursor
 
     public fun beginTransaction()
     public fun setTransactionSuccessful()

diff --git a/sqllin-driver/src/jvmMain/kotlin/com/ctrip/sqllin/driver/AbstractJdbcDatabaseConnection.kt b/sqllin-driver/src/jvmMain/kotlin/com/ctrip/sqllin/driver/AbstractJdbcDatabaseConnection.kt
@@ -29,7 +29,7 @@ internal abstract class AbstractJdbcDatabaseConnection : DatabaseConnection {
 
     abstract fun createStatement(sql: String): PreparedStatement
 
-    protected fun bindParamsToSQL(sql: String, bindParams: Array<Any?>?): PreparedStatement = createStatement(sql).apply {
+    protected fun bindParamsToSQL(sql: String, bindParams: Array<out Any?>?): PreparedStatement = createStatement(sql).apply {
         bindParams?.run {
             require(isNotEmpty()) { "Empty bindArgs" }
             forEachIndexed { index, any ->

diff --git a/sqllin-driver/src/jvmMain/kotlin/com/ctrip/sqllin/driver/ConcurrentDatabaseConnection.kt b/sqllin-driver/src/jvmMain/kotlin/com/ctrip/sqllin/driver/ConcurrentDatabaseConnection.kt
@@ -28,19 +28,19 @@ internal class ConcurrentDatabaseConnection(private val delegateConnection: Data
 
     private val accessLock = ReentrantLock()
 
-    override fun execSQL(sql: String, bindParams: Array<Any?>?) = accessLock.withLock {
+    override fun execSQL(sql: String, bindParams: Array<out Any?>?) = accessLock.withLock {
         delegateConnection.execSQL(sql, bindParams)
     }
 
-    override fun executeInsert(sql: String, bindParams: Array<Any?>?) = accessLock.withLock {
+    override fun executeInsert(sql: String, bindParams: Array<out Any?>?) = accessLock.withLock {
         delegateConnection.executeInsert(sql, bindParams)
     }
 
-    override fun executeUpdateDelete(sql: String, bindParams: Array<Any?>?) = accessLock.withLock {
+    override fun executeUpdateDelete(sql: String, bindParams: Array<out Any?>?) = accessLock.withLock {
         delegateConnection.executeUpdateDelete(sql, bindParams)
     }
 
-    override fun query(sql: String, bindParams: Array<String?>?): CommonCursor = accessLock.withLock {
+    override fun query(sql: String, bindParams: Array<out String?>?): CommonCursor = accessLock.withLock {
         delegateConnection.query(sql, bindParams)
     }
 

diff --git a/sqllin-driver/src/jvmMain/kotlin/com/ctrip/sqllin/driver/JdbcDatabaseConnection.kt b/sqllin-driver/src/jvmMain/kotlin/com/ctrip/sqllin/driver/JdbcDatabaseConnection.kt
@@ -29,25 +29,25 @@ import java.util.concurrent.atomic.AtomicBoolean
 
 internal class JdbcDatabaseConnection(private val connection: Connection) : AbstractJdbcDatabaseConnection() {
 
-    override fun execSQL(sql: String, bindParams: Array<Any?>?) {
+    override fun execSQL(sql: String, bindParams: Array<out Any?>?) {
         bindParamsToSQL(sql, bindParams).use {
             it.execute()
         }
     }
 
-    override fun executeInsert(sql: String, bindParams: Array<Any?>?) {
+    override fun executeInsert(sql: String, bindParams: Array<out Any?>?) {
         executeUpdate(sql, bindParams)
     }
 
-    override fun executeUpdateDelete(sql: String, bindParams: Array<Any?>?) {
+    override fun executeUpdateDelete(sql: String, bindParams: Array<out Any?>?) {
         executeUpdate(sql, bindParams)
     }
 
-    private fun executeUpdate(sql: String, bindParams: Array<Any?>?): Int = bindParamsToSQL(sql, bindParams).use {
+    private fun executeUpdate(sql: String, bindParams: Array<out Any?>?): Int = bindParamsToSQL(sql, bindParams).use {
         it.executeUpdate()
     }
 
-    override fun query(sql: String, bindParams: Array<String?>?): CommonCursor {
+    override fun query(sql: String, bindParams: Array<out String?>?): CommonCursor {
         val statement = connection.prepareStatement(sql)
         bindParams?.forEachIndexed { index, str ->
             str?.let {

diff --git a/sqllin-driver/src/nativeMain/kotlin/com/ctrip/sqllin/driver/ConcurrentDatabaseConnection.kt b/sqllin-driver/src/nativeMain/kotlin/com/ctrip/sqllin/driver/ConcurrentDatabaseConnection.kt
@@ -30,19 +30,19 @@ internal class ConcurrentDatabaseConnection(
 
     private val accessLock = Lock()
 
-    override fun execSQL(sql: String, bindParams: Array<Any?>?) = accessLock.withLock {
+    override fun execSQL(sql: String, bindParams: Array<out Any?>?) = accessLock.withLock {
         delegateConnection.execSQL(sql, bindParams)
     }
 
-    override fun executeInsert(sql: String, bindParams: Array<Any?>?) = accessLock.withLock {
+    override fun executeInsert(sql: String, bindParams: Array<out Any?>?) = accessLock.withLock {
         delegateConnection.executeInsert(sql, bindParams)
     }
 
-    override fun executeUpdateDelete(sql: String, bindParams: Array<Any?>?) = accessLock.withLock {
+    override fun executeUpdateDelete(sql: String, bindParams: Array<out Any?>?) = accessLock.withLock {
         delegateConnection.executeUpdateDelete(sql, bindParams)
     }
 
-    override fun query(sql: String, bindParams: Array<String?>?): CommonCursor = accessLock.withLock {
+    override fun query(sql: String, bindParams: Array<out String?>?): CommonCursor = accessLock.withLock {
         delegateConnection.query(sql, bindParams)
     }
 

diff --git a/sqllin-driver/src/nativeMain/kotlin/com/ctrip/sqllin/driver/NativeDatabaseConnection.kt b/sqllin-driver/src/nativeMain/kotlin/com/ctrip/sqllin/driver/NativeDatabaseConnection.kt
@@ -25,7 +25,7 @@ internal abstract class NativeDatabaseConnection : DatabaseConnection {
 
     abstract fun createStatement(sql: String): SQLiteStatement
 
-    protected fun bindParamsToSQL(sql: String, bindParams: Array<Any?>?): SQLiteStatement = createStatement(sql).apply {
+    protected fun bindParamsToSQL(sql: String, bindParams: Array<out Any?>?): SQLiteStatement = createStatement(sql).apply {
         bindParams?.run {
             require(isNotEmpty()) { "Empty bindArgs" }
             forEachIndexed { index, any ->

diff --git a/sqllin-driver/src/nativeMain/kotlin/com/ctrip/sqllin/driver/RealDatabaseConnection.kt b/sqllin-driver/src/nativeMain/kotlin/com/ctrip/sqllin/driver/RealDatabaseConnection.kt
@@ -37,7 +37,7 @@ internal class RealDatabaseConnection(
 
     private data class Transaction(val isSuccessful: Boolean)
 
-    override fun execSQL(sql: String, bindParams: Array<Any?>?) =
+    override fun execSQL(sql: String, bindParams: Array<out Any?>?) =
         if (bindParams == null) {
             database.rawExecSql(sql)
         } else {
@@ -49,7 +49,7 @@ internal class RealDatabaseConnection(
             }
         }
 
-    override fun executeInsert(sql: String, bindParams: Array<Any?>?) {
+    override fun executeInsert(sql: String, bindParams: Array<out Any?>?) {
         val statement = bindParamsToSQL(sql, bindParams)
         try {
             statement.executeInsert()
@@ -58,7 +58,7 @@ internal class RealDatabaseConnection(
         }
     }
 
-    override fun executeUpdateDelete(sql: String, bindParams: Array<Any?>?) {
+    override fun executeUpdateDelete(sql: String, bindParams: Array<out Any?>?) {
         val statement = bindParamsToSQL(sql, bindParams)
         try {
             statement.executeUpdateDelete()
@@ -67,7 +67,7 @@ internal class RealDatabaseConnection(
         }
     }
 
-    override fun query(sql: String, bindParams: Array<String?>?): CommonCursor {
+    override fun query(sql: String, bindParams: Array<out String?>?): CommonCursor {
         val statement = createStatement(sql)
         bindParams?.forEachIndexed { index, str ->
             str?.let {

diff --git a/sqllin-dsl/doc/getting-start-cn.md b/sqllin-dsl/doc/getting-start-cn.md
@@ -14,7 +14,7 @@ plugins {
     id("com.google.devtools.ksp")
 }
 
-val sqllinVersion = "1.2.4"
+val sqllinVersion = "1.3.0"
 
 kotlin {
     // ......

diff --git a/sqllin-dsl/doc/getting-start.md b/sqllin-dsl/doc/getting-start.md
@@ -16,7 +16,7 @@ plugins {
     id("com.google.devtools.ksp")
 }
 
-val sqllinVersion = "1.2.4"
+val sqllinVersion = "1.3.0"
 
 kotlin {
     // ......
@@ -30,10 +30,10 @@ kotlin {
                 implementation("com.ctrip.kotlin:sqllin-driver:$sqllinVersion")
 
                 // The sqllin-dsl serialization and deserialization depends on kotlinx-serialization
-                implementation("org.jetbrains.kotlinx:kotlinx-serialization-core:1.5.1")
+                implementation("org.jetbrains.kotlinx:kotlinx-serialization-core:1.6.3")
 
                 // Since 1.2.2, sqllin-dsl depends on kotlinx.coroutines
-                implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3")
+                implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.8.0")
             }
         }
         // ......

diff --git a/sqllin-dsl/src/commonMain/kotlin/com/ctrip/sqllin/dsl/DatabaseScope.kt b/sqllin-dsl/src/commonMain/kotlin/com/ctrip/sqllin/dsl/DatabaseScope.kt
@@ -124,7 +124,7 @@ public class DatabaseScope internal constructor(
      */
 
     public infix fun Table<*>.DELETE(x: X) {
-        val statement = Delete.deleteAllEntity(this, databaseConnection)
+        val statement = Delete.deleteAllEntities(this, databaseConnection)
         addStatement(statement)
     }
 

diff --git a/sqllin-dsl/src/commonMain/kotlin/com/ctrip/sqllin/dsl/sql/clause/BaseJoinClause.kt b/sqllin-dsl/src/commonMain/kotlin/com/ctrip/sqllin/dsl/sql/clause/BaseJoinClause.kt
@@ -47,7 +47,6 @@ public sealed class JoinClause<R>(vararg tables: Table<*>) : BaseJoinClause<R>(*
 public infix fun <R> JoinStatementWithoutCondition<R>.ON(condition: SelectCondition): JoinSelectStatement<R> =
     convertToJoinSelectStatement(condition)
 
-@Suppress("NOTHING_TO_INLINE")
 public inline infix fun <R> JoinStatementWithoutCondition<R>.USING(clauseElement: ClauseElement): JoinSelectStatement<R> =
     USING(listOf(clauseElement))
 

diff --git a/sqllin-dsl/src/commonMain/kotlin/com/ctrip/sqllin/dsl/sql/clause/ClauseBoolean.kt b/sqllin-dsl/src/commonMain/kotlin/com/ctrip/sqllin/dsl/sql/clause/ClauseBoolean.kt
@@ -36,15 +36,13 @@ public class ClauseBoolean(
                 append('.')
             }
             append(valueName)
-            append(' ')
             if (bool)
-                append('>')
+                append(" > ")
             else
-                append("<=")
-            append(' ')
+                append(" <= ")
             append(0)
         }
-        return SelectCondition(sql)
+        return SelectCondition(sql, null)
     }
 
     override fun hashCode(): Int = valueName.hashCode() + table.tableName.hashCode()

diff --git a/sqllin-dsl/src/commonMain/kotlin/com/ctrip/sqllin/dsl/sql/clause/ClauseNumber.kt b/sqllin-dsl/src/commonMain/kotlin/com/ctrip/sqllin/dsl/sql/clause/ClauseNumber.kt
@@ -81,7 +81,7 @@ public class ClauseNumber(
                 append(symbol)
             } while (hasNext)
         }
-        return SelectCondition(sql)
+        return SelectCondition(sql, null)
     }
 
     internal infix fun between(range: LongRange): SelectCondition {
@@ -96,7 +96,7 @@ public class ClauseNumber(
             append(" AND ")
             append(range.last)
         }
-        return SelectCondition(sql)
+        return SelectCondition(sql, null)
     }
 
     private fun appendNumber(symbol: String, number: Number): SelectCondition {
@@ -111,7 +111,7 @@ public class ClauseNumber(
             append(' ')
             append(number)
         }
-        return SelectCondition(sql)
+        return SelectCondition(sql, null)
     }
 
     private fun appendNullableNumber(notNullSymbol: String, nullSymbol: String, number: Number?): SelectCondition {
@@ -126,7 +126,7 @@ public class ClauseNumber(
             append(' ')
             append(number ?: "NULL")
         }
-        return SelectCondition(sql)
+        return SelectCondition(sql, null)
     }
 
     private fun appendClauseNumber(symbol: String, clauseNumber: ClauseNumber): SelectCondition {
@@ -141,7 +141,7 @@ public class ClauseNumber(
             append('.')
             append(clauseNumber.valueName)
         }
-        return SelectCondition(sql)
+        return SelectCondition(sql, null)
     }
 
     override fun hashCode(): Int = valueName.hashCode() + table.tableName.hashCode()

diff --git a/sqllin-dsl/src/commonMain/kotlin/com/ctrip/sqllin/dsl/sql/clause/ClauseString.kt b/sqllin-dsl/src/commonMain/kotlin/com/ctrip/sqllin/dsl/sql/clause/ClauseString.kt
@@ -54,12 +54,9 @@ public class ClauseString(
             append(valueName)
             append(' ')
             append(symbol)
-            append(' ')
-            append('\'')
-            append(regex)
-            append('\'')
+            append(" ?")
         }
-        return SelectCondition(sql)
+        return SelectCondition(sql, mutableListOf(regex))
     }
 
     private fun appendString(notNullSymbol: String, nullSymbol: String, str: String?): SelectCondition {
@@ -73,16 +70,12 @@ public class ClauseString(
             val isNull = str == null
             val symbol = if (isNull) nullSymbol else notNullSymbol
             append(symbol)
-            append(' ')
             if (str == null)
                 append(" NULL")
-            else {
-                append('\'')
-                append(str)
-                append('\'')
-            }
+            else
+                append(" ?")
         }
-        return SelectCondition(sql)
+        return SelectCondition(sql, if (str == null) null else mutableListOf(str))
     }
 
     private fun appendClauseString(symbol: String, clauseString: ClauseString): SelectCondition {
@@ -97,7 +90,7 @@ public class ClauseString(
             append('.')
             append(clauseString.valueName)
         }
-        return SelectCondition(sql)
+        return SelectCondition(sql, null)
     }
 
     override fun hashCode(): Int = valueName.hashCode() + table.tableName.hashCode()

diff --git a/sqllin-dsl/src/commonMain/kotlin/com/ctrip/sqllin/dsl/sql/clause/ConditionClause.kt b/sqllin-dsl/src/commonMain/kotlin/com/ctrip/sqllin/dsl/sql/clause/ConditionClause.kt
@@ -18,7 +18,7 @@ package com.ctrip.sqllin.dsl.sql.clause
 
 /**
  * Abstract clause that could link conditions, include 'WHERE' and 'HAVING'
- * @author yaquai
+ * @author yaqiao
  */
 
 public sealed class ConditionClause<T>(private val selectCondition: SelectCondition) : SelectClause<T> {