开发必备：EsayCode使用以及Oracle自定义模板

前言

写前先问一句，不会还有人在手动写这些基础的sql语句吧？！

最近在做Oracle的项目，手写mapper和entity文件真是写到手软，以前MySQL都是找的线上自动生成的，现在也不行了。

找了很长时间，也试验了一下mybaties-plus，后来要感谢掘金群里的老哥（图片已同意）。虽然默认模板很难用，但是自定义模板优化后，凑合可以使用吧。

使用

1.下载插件

2.连接数据库（自选Oracle或者MySQL）

这里说一下Oracle的连接，只有SID，但是一般情况是我们只知道服务名。URL中可以直接把我们application中Oracle的连接配置放进去，注意地址中：是SID。/是服务名，这是个小区别。一旦写错，就无法连接了，SID需要去安装目录下查看。

3.文件生成

标注的从上到下的选项依次是：包地址，模板选择，生成文件选项（自定义选择）

Oracle模板

大家使用Oracle模板时最好是重新创建一份配置，不要动系统默认的那一份。我自己因为只需要mapper和entity文件，所以只修改了mapper、entity和dao，其中mapper是最难得，下面将着重讲一下遇到的坑和要点。着急的可以先去使用，不符合自己需求的在查看修改。

1.mapper.xml.vm

##引入mybatis支持
$!{mybatisSupport.vm}
##设置保存名称与保存位置
$!callback.setFileName($tool.append($!{tableInfo.name}, "Mapper.xml"))
$!callback.setSavePath($tool.append($modulePath, "/src/main/resources/mapper"))
##拿到主键
#if(!$tableInfo.pkColumn.isEmpty())
#set($pk = $tableInfo.pkColumn.get(0))
#end
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="$!{tableInfo.savePackageName}.mapper.$!{tableInfo.name}Mapper">
<resultMap type="$!{tableInfo.savePackageName}.domain.$!{tableInfo.name}" id="$!{tableInfo.name}Map">
#foreach($column in $tableInfo.fullColumn)
<result property="$!column.name" column="$!column.obj.name" jdbcType="$!column.ext.jdbcType"/>
#end
</resultMap>
<!--查询单个-->
<select id="queryById" resultMap="$!{tableInfo.name}Map">
select
#allSqlColumn()
from $!tableInfo.obj.name
where $!pk.obj.name = #{$!pk.name}
</select>
<!--查询指定行数据-->
<select id="queryAll" resultMap="$!{tableInfo.name}Map">
select
#allSqlColumn()
from $!tableInfo.obj.name
<where>
#foreach($column in $tableInfo.fullColumn)
<if test="$!column.name != null#if($column.type.equals("java.lang.String")) and $!column.name != ''#end">
and $!column.obj.name = #{$!column.name}
</if>
#end
</where>

</select>
<!--统计总行数-->
<select id="count" resultType="java.lang.Long">
select count(1)
from $!tableInfo.obj.name
<where>
#foreach($column in $tableInfo.fullColumn)
<if test="$!column.name != null#if($column.type.equals("java.lang.String")) and $!column.name != ''#end">
and $!column.obj.name = #{$!column.name}
</if>
#end
</where>
</select>
<!--新增所有列-->
<insert id="insert" keyProperty="$!pk.name" useGeneratedKeys="true">
insert into "$!{tableInfo.obj.name}"
<trim prefix="(" suffix=")" suffixOverrides=",">
#foreach($column in $tableInfo.otherColumn)
<if test="$!column.name != null#if($column.type.equals("java.lang.String")) and $!column.name != ''#end">
"$!column.obj.name",
</if>
#end
</trim>
<trim prefix="values (" suffix=")" suffixOverrides=",">
#foreach($column in $tableInfo.otherColumn)
<if test="$!column.name != null#if($column.type.equals("java.lang.String")) and $!column.name != ''#end">
#{$!column.name},
</if>
#end
</trim>
</insert>

<!--通过主键修改数据-->
<update id="update">
update $!{tableInfo.obj.name}
<set>
#foreach($column in $tableInfo.otherColumn)
<if test="$!column.name != null#if($column.type.equals("java.lang.String")) and $!column.name != ''#end">
"$!column.obj.name" = #{$!column.name},
</if>
#end
</set>
where "$!pk.obj.name" = #{$!pk.name}
</update>
<!--通过主键删除-->
<delete id="deleteById">
delete from $!{tableInfo.obj.name} where $!pk.obj.name = #{$!pk.name}
</delete>


<insert id="insertBatch" keyProperty="$!pk.name" useGeneratedKeys="true">
insert into $!{tableInfo.obj.name}(#foreach($column in $tableInfo.otherColumn)$!column.obj.name#if($velocityHasNext), #end#end)
values
<foreach collection="entities" item="entity" separator=",">
(#foreach($column in $tableInfo.otherColumn)#{entity.$!{column.name}}#if($velocityHasNext), #end#end)
</foreach>
</insert>
</mapper

模板需要关注的字符

#allSqlColumn() ，这个代表的是所有字段，本来我是想用个<sql></sql>标签替代的，把所有字段总结到一起。看着简洁一些，但是发现改变后模板报错，无奈只能放着。

$!column.name：entity中的属性名；

$!column.obj.name：表中的字段名；

$!pk.obj.name：表主键名称；

下面可以设置引入dao层的地址，以及后缀，根据个人需要编写。

<mapper namespace="$!{tableInfo.savePackageName}.mapper.$!{tableInfo.name}Mapper">

2.dao.java.vm

##定义初始变量
#set($tableName = $tool.append($tableInfo.name, "Mapper"))
##设置回调
$!callback.setFileName($tool.append($tableName, ".java"))
$!callback.setSavePath($tool.append($tableInfo.savePath, "/mapper"))

##拿到主键
#if(!$tableInfo.pkColumn.isEmpty())
    #set($pk = $tableInfo.pkColumn.get(0))
#end

#if($tableInfo.savePackageName)package $!{tableInfo.savePackageName}.#{end}mapper;

import $!{tableInfo.savePackageName}.domain.$!{tableInfo.name};
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.Mapper;
import java.util.List;

/**
 * $!{tableInfo.comment}($!{tableInfo.name})表数据库访问层
 *
 * @author $!author
 * @since $!time.currTime()
 */
@Mapper
public interface $!{tableName} {

    /**
     * 查询所有数据
     *
     * @return 实例对象集合
     */
    List<$!{tableInfo.name}> queryAll();
     
    /**
     * 通过ID查询单条数据
     *
     * @param $!pk.name 主键
     * @return 实例对象
     */
    $!{tableInfo.name} queryById($!pk.shortType $!pk.name);
     
    /**
     * 统计总行数
     *
     * @param $!tool.firstLowerCase($!{tableInfo.name}) 查询条件
     * @return 总行数
     */
    long count($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name}));

    /**
     * 新增数据
     *
     * @param $!tool.firstLowerCase($!{tableInfo.name}) 实例对象
     * @return 影响行数
     */
    int insert($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name}));

    /**
     * 批量新增数据（MyBatis原生foreach方法）
     *
     * @param entities List<$!{tableInfo.name}> 实例对象列表
     * @return 影响行数
     */
    int insertBatch(@Param("entities") List<$!{tableInfo.name}> entities);

  
    /**
     * 修改数据
     *
     * @param $!tool.firstLowerCase($!{tableInfo.name}) 实例对象
     * @return 影响行数
     */
    int update($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name}));

    /**
     * 通过主键删除数据
     *
     * @param $!pk.name 主键
     * @return 影响行数
     */
    int deleteById($!pk.shortType $!pk.name);

}

达到的效果

1.select查询从固定查所有字段，变为根据入参字段值是否存在查询。

2.insert和update语句同上，这里需要注意的是Oracle需要给表名和字段名加上双引号，否则sql报错。

MySQL

MySQL如果也想用EasyCode的话，可以自己试着编辑下。提示：把模板里的语句改为MySQL的就好。

不愿意使用的话，提供给大家两个网站在线生成的，也很强大：

http://www.javacoder.top/

https://utilsbox.cn/?app=bizcode

问题

有时候模板配好了但是会报错，这时候如何检查模板没有问题，那就重新试试别的idea窗口，我的就是这样好了，当时为难了半天。或者点击config Table然后重启。

更新：模板优化

这次改动主要在于查询这里，因为Oracle同MySQL不同，如果说你的字段中使用诸如：type、date这种字段，就需要给它加上双引号，否则就会报sql异常；而我试了一下字段都加上双引号也是没有其他问题的。我们只需要修改查询：

 <!--查询单个-->
    <select id="queryById" resultMap="$!{tableInfo.name}Map">
        select * from $!tableInfo.obj.name
        where $!pk.obj.name = #{$!pk.name}
    </select>

    <!--查询指定行数据-->
    <select id="queryAll" resultMap="$!{tableInfo.name}Map">
        select * from $!tableInfo.obj.name
        <where>
#foreach($column in $tableInfo.fullColumn)
            <if test="$!column.name != null#if($column.type.equals("java.lang.String")) and $!column.name != ''#end">
                and "$!column.obj.name" = #{$!column.name}
            </if>
#end
        </where>
        
    </select>