magic-api使用示例：增删改查及mybatis语法支持说明

增删改查

#SQL参数

##{} 注入参数

作用和mybatis一致，都是将#{}区域替换为占位符?

var id = 123;
return db.select("""
    select * from sys_user where id = #{id}
""");

运行时生成的SQL为：select * from sys_user where id = ?。

参数id值会被注入为123。

此方法可以避免sql注入。

#${} 拼接参数

作用和mybatis一致，都是将${}区域替换为对应的字符串

var id = 123;
return db.select("""
    select * from sys_user where id = ${id}
""");

运行时生成的SQL为：select * from sys_user where id = 123

#动态SQL参数

通过?{condition,expression}来实现动态拼接SQL，如果条件成立则拼接后部分内容SQL中，与mybatis中的if标签基本一致

return db.select("select * from sys_user ?{id,where id = #{id}}");
// 当id有值时,生成SQL：select * from sys_user where id = ?`，相当于mybatis中的<if test="id != null and id != ''">
// 当id无值时,生成SQL：select * from sys_user
return db.select("select * from sys_user ?{id!=null&&id.length() > 3,where id = #{id}}");
// 当id!=null&&id.length() > 3判断为true时,生成SQL：`select * from sys_user where id = ?
// 当判断为false时,生成SQL：select * from sys_user

#切换数据源

// 从数据源key定义为slave的库中查询
return db.slave.select("""
    select * from sys_user
""")

#SQL缓存

// 将查询结果缓存到名为user_cache的缓存中，有效期1小时
return db.cache("user_cache", 3600 * 1000).select("""
    select * from sys_user
""")
// 当执行以下语句时，将清空user_cache缓存
db.cache("user_cache").update(""" ...... """)
db.cache("user_cache").insert(""" ...... """)

#使用事务

#自动事务

var val = db.transaction(()=>{
    
    
    var v1 = db.update('...');
    var v2 = db.update('....');
    return v2;
});
return val;

#手动事务

var tx = db.transaction();  //开启事务
try{
    
    
    var value = db.update('...');
    tx.commit();    // 提交事务
    return value;
}catch(e){
    
    
    tx.rollback();  // 回滚事务
}

#Mybatis语法支持1.6.0+

参考: https://mybatis.org/mybatis-3/zh/dynamic-sql.html

#关键字

目前支持的关键字如下

关键字
<if>
<elseif>
<else>
<where>
<foreach>
<trim>
<set>

#if

示例:

var sql = """
select * from test_data
	where 1 = 1
	<if test="id != null">
        and id = #{
    
    id}
    </if>
"""
return db.select(sql)

这条语句提供了可选的查找id功能。如果不传入id，将会返回所有数据，否则返回id匹配的数据。

#elseif

var sql = """
select * from test_data
	where 1 = 1
	<if test="id == null">
        and id = 0
    </if>
    <elseif test="id < 1000">
        and id = #{
    
    id}
    </elseif>
"""
return db.select(sql)

这条语句提供了可选的查找id功能。如果不传入id，将拼接 and id = 0，否则id小于1000时拼接and id = #{id}

#else

var sql = """
select * from test_data
	where
	<if test="id == null">
        id = 0
    </if>
    <else>
        id = #{
    
    id}
    </else>
"""
return db.select(sql)

这条语句提供了可选的查找id功能。如果不传入id，将拼接 and id = 0，否则拼接and id = #{id}

#where

var sql = """
select * from test_data
<where>
    <if test="id != null">
        and id = #{
    
    id}
    </if>
</where>
"""
return db.select(sql)

where元素只会在子元素返回任何内容的情况下才插入WHERE子句。而且，若子句的开头为AND或OR，where元素也会将它们去除。

如果 where元素与你期望的不太一样，你也可以通过自定义trim元素来定制 where元素的功能。比如，和where元素等价的自定义trim元素为：

<trim prefix="WHERE" prefixOverrides="AND |OR ">
  ...
</trim>

prefixOverrides属性会忽略通过管道符分隔的文本序列（注意此例中的空格是必要的）。上述例子会移除所有prefixOverrides属性中指定的内容，并且插入prefix属性中指定的内容。

#set、trim

用于动态更新语句的类似解决方案叫做set。set元素可以用于动态包含需要更新的列，忽略其它不更新的列。比如：

var sql = """
update test_data
    <set>
        <if test="name != null">
            name = #{
    
    name}
        </if>
        <if test="content != null">
            content = #{
    
    content}
        </if>
    </set>
    where `id` = #{
    
    id}
"""
return db.update(sql)

这个例子中，set 元素会动态地在行首插入SET关键字，并会删掉额外的逗号（这些逗号是在使用条件语句给列赋值时引入的）。

来看看与set元素等价的自定义trim元素吧：

<trim prefix="SET" suffixOverrides=",">
  ...
</trim>

注意，我们覆盖了后缀值设置，并且自定义了前缀值。

#foreach

动态SQL的另一个常见使用场景是对集合进行遍历（尤其是在构建IN条件语句的时候）。比如：

var sql = """
select * from test_data
where id in
<foreach item='item' index='index' collection='body.ids'
      open="(" separator="," close=")">
    #{
    
    item}
</foreach>
"""
return db.select(sql)

foreach 元素的功能非常强大，它允许你指定一个集合，声明可以在元素体内使用的集合项item和索引index变量。它也允许你指定开头与结尾的字符串以及集合项迭代之间的分隔符。

---

links：

增删改查 | magic-api