修正 sql error 参数截断逻辑不生效的 bug，并补充相关单元测试。

Author: bunnier

errors.go

@@ -27,9 +27,6 @@ var (
 	ErrExecutingSql = errors.New("dbClient: failed to execute sql")
 )
 
-// MaxLengthErrorValue 用于限制错误中 Value 值的长度，超过该大小将会进行截断。
-var MaxLengthErrorValue = 64 * 1024
-
 // getExecutingSqlError 用于生成一个带着 SQL 和参数列表的 ErrExecutingSql。
 // 错误内容中包含了：原始传入的 SQL，解析后的 SQL，参数列表。
 func getExecutingSqlError(err error, rawSql string, fixedSql string, params []any) error {
@@ -56,24 +53,42 @@ func printSqlParams(params []interface{}) string {
 		switch v := param.(type) {
 		// 如果是命名参数，打印出 name/value 对。
 		case sql.NamedArg:
-			logVal := v.Value
-
-			stringVal, ok := v.Value.(fmt.Stringer)
-			if ok {
-				logStringValue := stringVal.String()
-				// string 类型的日志，参考 MaxLengthErrorValue 的值，对输出长度进行截取，以避免 Value 长度过长时候，输出过大的日志。
-				if len(logStringValue) > MaxLengthErrorValue {
-					logStringValue = logStringValue[:MaxLengthErrorValue]
-				}
-				logVal = logStringValue
-			}
-
-			sb.WriteString(fmt.Sprintf("@%s=%v", v.Name, logVal))
+			sb.WriteString(fmt.Sprintf("@%s=%v", v.Name, cutLongStringParams(v.Value)))
 
 		// 非命名参数，索引按顺序打印。
 		default:
-			sb.WriteString(fmt.Sprintf("@p%d=%v", i+1, v))
+			sb.WriteString(fmt.Sprintf("@p%d=%v", i+1, cutLongStringParams(v)))
 		}
 	}
 	return sb.String()
 }
+
+// MaxLengthErrorValue 用于限制错误输出中参数的长度，超过该大小将会进行截断。
+// NOTE: 可自行调整该值。
+var MaxLengthErrorValue = 64 * 1024
+
+// 本方法用于对参数进行处理，以避免在 error 中输出过大的字符串。
+func cutLongStringParams(paramVal any) any {
+	var paramValString string
+	switch v := paramVal.(type) {
+	case string:
+		paramValString = v
+	case fmt.Stringer:
+		paramValString = v.String()
+	default:
+		return paramVal
+	}
+
+	if len(paramValString) <= MaxLengthErrorValue {
+		return paramValString
+	}
+
+	// 超过长度的字符串，截取前 MaxLengthErrorValue 个字符，后面用 ... 填充，并注明参数大小。
+	var paramStringBuilder strings.Builder
+	paramStringBuilder.Grow(MaxLengthErrorValue + 24)
+	paramStringBuilder.WriteString(paramValString[:MaxLengthErrorValue])
+	paramStringBuilder.WriteString("...")
+	paramStringBuilder.WriteString(fmt.Sprintf("(length=%d)", len(paramValString)))
+
+	return paramStringBuilder.String()
+}

errors_test.go

@@ -0,0 +1,139 @@
+package sqlmer
+
+import (
+	"database/sql"
+	"errors"
+	"strings"
+	"testing"
+)
+
+func TestGetExecutingSqlError(t *testing.T) {
+	tests := []struct {
+		name     string
+		err      error
+		rawSql   string
+		fixedSql string
+		params   []any
+		wantErr  string
+	}{
+		{
+			name:     "Basic Error Test",
+			err:      errors.New("test error"),
+			rawSql:   "SELECT * FROM users WHERE id = @p1",
+			fixedSql: "SELECT * FROM users WHERE id = ?",
+			params:   []any{1},
+			wantErr:  "dbClient: failed to execute sql\nraw error: test error\nsql:\ninput sql=SELECT * FROM users WHERE id = @p1\nexecuting sql=SELECT * FROM users WHERE id = ?\nparams:\n@p1=1",
+		},
+		{
+			name:     "Named Parameter Test",
+			err:      errors.New("test error"),
+			rawSql:   "SELECT * FROM users WHERE name = @name",
+			fixedSql: "SELECT * FROM users WHERE name = ?",
+			params:   []any{sql.Named("name", "test")},
+			wantErr:  "dbClient: failed to execute sql\nraw error: test error\nsql:\ninput sql=SELECT * FROM users WHERE name = @name\nexecuting sql=SELECT * FROM users WHERE name = ?\nparams:\n@name=test",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			gotErr := getExecutingSqlError(tt.err, tt.rawSql, tt.fixedSql, tt.params)
+			if gotErr.Error() != tt.wantErr {
+				t.Errorf("getExecutingSqlError() error = %v, want %v", gotErr, tt.wantErr)
+			}
+		})
+	}
+}
+
+func TestGetSqlError(t *testing.T) {
+	tests := []struct {
+		name    string
+		err     error
+		rawSql  string
+		params  []any
+		wantErr string
+	}{
+		{
+			name:    "Basic Error Test",
+			err:     ErrExpectedSizeWrong,
+			rawSql:  "UPDATE users SET name = @p1",
+			params:  []any{"test"},
+			wantErr: "dbClient: effected rows was wrong\nsql:\ninput sql=UPDATE users SET name = @p1\nparams:\n@p1=test",
+		},
+		{
+			name:    "Named Parameter Test",
+			err:     ErrParseParamFailed,
+			rawSql:  "INSERT INTO users (name) VALUES (@name)",
+			params:  []any{sql.Named("name", "test")},
+			wantErr: "dbClient: failed to parse named params\nsql:\ninput sql=INSERT INTO users (name) VALUES (@name)\nparams:\n@name=test",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			gotErr := getSqlError(tt.err, tt.rawSql, tt.params)
+			if gotErr.Error() != tt.wantErr {
+				t.Errorf("getSqlError() error = %v, want %v", gotErr, tt.wantErr)
+			}
+		})
+	}
+}
+
+func TestCutLongStringParams(t *testing.T) {
+	originalMaxLength := MaxLengthErrorValue
+	defer func() { MaxLengthErrorValue = originalMaxLength }()
+
+	// 为了便于测试，将最大长度设置为较小的值
+	MaxLengthErrorValue = 10
+
+	tests := []struct {
+		name     string
+		paramVal any
+		want     any
+	}{
+		{
+			name:     "Short String",
+			paramVal: "test",
+			want:     "test",
+		},
+		{
+			name:     "Long String",
+			paramVal: "this is a very long string",
+			want:     "this is a ...(length=24)",
+		},
+		{
+			name:     "Non-String Type",
+			paramVal: 123,
+			want:     123,
+		},
+		{
+			name:     "Stringer Interface",
+			paramVal: testStringer{"this is a very long string"},
+			want:     "this is a ...(length=24)",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got := cutLongStringParams(tt.paramVal)
+			if got != tt.want {
+				// 对于字符串类型的结果，检查是否包含预期的内容
+				if s, ok := got.(string); ok {
+					if !strings.Contains(s, "...(length=") {
+						t.Errorf("cutLongStringParams() = %v, want %v", got, tt.want)
+					}
+				} else {
+					t.Errorf("cutLongStringParams() = %v, want %v", got, tt.want)
+				}
+			}
+		})
+	}
+}
+
+// 用于测试 Stringer 接口的辅助类型
+type testStringer struct {
+	value string
+}
+
+func (ts testStringer) String() string {
+	return ts.value
+}