mybatis.xml中sql编写规范

最新推荐文章于 2024-06-05 23:16:37 发布
最新推荐文章于 2024-06-05 23:16:37 发布
阅读量960 收藏
点赞数
分类专栏： JAVA进阶 文章标签： mybatis xml sql规范
[size=medium][b]一、越少的代码，越强悍的功能，xml里面应该6个sql语句就够用了，修改，维护成本很低，见下表[/b][/size]
[table]
|[b]英文名[/b]|[b]方法名称[/b]|[b]核心点[/b]|[b]建议[/b]|
|insert|1.新增数据|如果是自增主键，应该返回主键ID||
|deleteById|2. 根据主键ID删除数据|sql默认加limit 1，防止多删数据|此方法不建议有，建议逻辑删除|
|updateById|3. 根据主键ID修改数据|sql默认加limit 1，防止多修改数据||
|selectById|4. 根据主键查询数据|查询一条数据||
|selectByIdForUpdate|5. 根据主键加锁查询数据|加锁查询一条数据，事务处理用|
|queryListByParam|6. 根据输入条件查询数据列表|和7配合使用||
|queryCountByParam|7. 根据输入条件查询总数|和6配合使用||
[/table]

[size=medium][b]二、公共的查询条件和字段列表等抽出公共sql段，方便使用[/b][/size]
[table]
|[b]英文名[/b]|[b]方法名称[/b]|[b]核心点[/b]|[b]建议[/b]|
|_field_list|1.字段列表|修改方便，方便字段排序||
|_value_list|2. 字段值列表|修改方便，方便字段值排序||
|_common_where|3. 通用查询条件|每个字段的等值判断||
|_regin_where|4. 通用范围区间条件|字段的时间区间，字段的金额区间等的判断||
|_contain_where|5. 包含字段值范围条件|字段的常量值包含判断，in ，not in|
|_common_sorts|6. 通用排序条件|order by||
[/table]

[size=medium][b]三、一个mybatis.xml例子[/b][/size] 
<?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="Assets">


	<!-- 设置1分钟缓存,缓存大小1024，采用最近最少使用算法 -->
	<cache readOnly="true" flushInterval="60000" size="10" eviction="LRU" />

	<resultMap type="Assets" id="AssetsResultMap">
		<id property="id" column="id" />
		<result property="userId" column="user_id" />
		<result property="amount" column="amount" />
		<result property="earning" column="earning" />
		<result property="type" column="type" />
		<result property="status" column="status" />
		<result property="productId" column="product_id" />
		<result property="productName" column="product_name" />
		<result property="cardNo" column="card_no" />
		<result property="bankCode" column="bank_code" />
		<result property="orderId" column="order_id" />
		<result property="effectiveDate" column="effective_date" />
		<result property="redeemType" column="redeem_type"/>
		<result property="initAmount" column="init_amount"/>
		<result property="initEarning" column="init_earning"/>
		<result property="redeemingAmount" column="redeeming_amount"/>
		<result property="redeemingEarning" column="redeeming_earning"/>
		<result property="redeemedAmount" column="redeemed_amount"/>
		<result property="redeemedEarning" column="redeemed_earning"/>
		<result property="punishAmount" column="punish_amount"/>
		<result property="latestRedeemTime" column="latest_redeem_time"/>
		<result property="maturityDate" column="maturity_date"/>
		<result property="createTime" column="create_time" />
		<result property="modifyTime" column="modify_time" />
		<result property="remark" column="remark" />
	</resultMap>

	<!-- 字段列表 -->
    <sql id="_field_list">
	    id, 
	    user_id, 
	    amount, 
	    earning, 
	    type, 
	    status, 
		product_id, 
		product_name,
		card_no, 
		bank_code, 
		order_id, 
		effective_date, 
		redeem_type, 
		init_amount, 
		init_earning, 
		redeeming_amount,
		redeeming_earning,
		redeemed_amount, 
		redeemed_earning, 
		punish_amount,
		latest_redeem_time, 
		maturity_date,
		create_time, 
		modify_time,
		remark
    </sql>

	<!-- 字段值列表 -->
    <sql id="_value_list">
        #{id}, 
        #{userId},
		#{amount}, 
		#{earning}, 
		#{type}, 
		#{status}, 
		#{productId}, 
		#{productName}, 
		#{cardNo}, 
		#{bankCode}, 
		#{orderId}, 
		#{effectiveDate}, 
		#{redeemType}, 
		#{initAmount}, 
		#{initEarning}, 
		#{redeemingAmount},
		#{redeemingEarning},
		#{redeemedAmount}, 
		#{redeemedEarning}, 
		#{punishAmount},
		#{latestRedeemTime}, 
		#{maturityDate},
		#{createTime},
		#{modifyTime}, 
		#{remark}
    </sql>

    <!-- 通用查询条件  不支持ID查询条件,ID的直接通过ID即可以查 -->
	<sql id="_common_where">
		<if test="id != null"> AND id = #{id}</if>
		<if test="userId != null"> AND user_id = #{userId}</if>
		<if test="amount != null"> AND amount = #{amount}</if>
		<if test="earning != null"> AND earning = #{earning}</if>
		<if test="type != null"> AND type = #{type}</if>
		<if test="status != null"> AND status = #{status}</if>
		<if test="productId != null"> AND product_id = #{productId}</if>
		<if test="productName != null"> AND product_name = #{productName}</if>
		<if test="cardNo != null"> AND card_no = #{cardNo}</if>
		<if test="bankCode != null"> AND bank_code = #{bankCode}</if>
		<if test="orderId != null"> AND order_id = #{orderId}</if>
		<if test="effectiveDate != null"> AND effective_date = #{effectiveDate}</if>
		<if test="redeemType != null"> AND redeem_type = #{redeemType}</if>
		<if test="initAmount != null"> AND init_amount = #{initAmount}</if>
		<if test="initEarning != null"> AND init_earning = #{initEarning}</if>
		<if test="redeemingAmount != null"> AND redeeming_amount = #{redeemingAmount}</if>
		<if test="redeemingEarning != null"> AND redeeming_earning = #{redeemingEarning}</if>
		<if test="redeemedAmount != null"> AND redeemed_amount = #{redeemedAmount}</if>
		<if test="redeemedEarning != null"> AND redeemed_earning = #{redeemedEarning}</if>
		<if test="punishAmount != null"> AND punish_amount = #{punishAmount}</if>
		<if test="latestRedeemTime != null">
			<![CDATA[
				AND latest_redeem_time = #{latestRedeemTime, jdbcType=TIMESTAMP} 
			]]>
		</if>
		<if test="maturityDate != null">
			<![CDATA[
				AND maturity_date = #{maturityDate, jdbcType=TIMESTAMP} 
			]]>
		</if>
		<if test="createTime != null">
			<![CDATA[
				AND create_time = #{createTime, jdbcType=TIMESTAMP} 
			]]>
		</if>
		<if test="modifyTime != null">
			<![CDATA[
				AND modify_time = #{modifyTime, jdbcType=TIMESTAMP} 
			]]>
		</if>
		<if test="remark != null"> AND remark = #{remark}</if>
	</sql>


	<!-- 通用范围区间查询 -->
	<sql id="_regin_where">
		<if test="egtCreateTime != null">
			<![CDATA[
				AND create_time >= #{egtCreateTime, jdbcType=TIMESTAMP} 
			]]>
		</if>
		<if test="ltCreateTime != null">
			<![CDATA[
				AND create_time < #{ltCreateTime, jdbcType=TIMESTAMP} 
			]]>
		</if>
	</sql>


	<!-- 通用排序处理 -->
	<sql id="_common_sorts">
		<if test="sorts != null">
			ORDER BY
			<foreach collection="sorts" item="item" separator=",">
				${item.column.columnName} ${item.sortMode.mode}
			</foreach>
		</if>
	</sql>


	<!-- in 和 not in的通用查询where -->
	<sql id="_contain_where">
		<if test="containStatusSet!=null">
	 	    AND status IN
	 		<foreach item="item" index="i" collection="containStatusSet" separator="," open="(" close=")" >  
	        	#{item}  
	    	</foreach>
	   	</if>

 	</sql>


	<!-- 插入操作 -->
	<insert id="insert" parameterType="Assets">
		INSERT INTO assets (
			<include refid="_field_list"/>)
		VALUES (
			<include refid="_value_list"/>)
	</insert>


	<!-- 根据ID主键进行删除，注意limit 1 -->
	<delete id="deleteById"  parameterType="java.lang.String" >
    	delete from assets where id = #{id} limit 1
  	</delete>	


	<!-- 根据主键ID进行更新，注意limit 1 -->
	<update id="updateById" parameterType="Assets">
		UPDATE assets
		<set>
			<if test="userId != null">
				user_id = #{userId},
			</if>
			<if test="amount != null">
				amount = #{amount},
			</if>
			<if test="earning != null">
				earning = #{earning},
			</if>
			<if test="type != null">
				type = #{type},
			</if>
			<if test="status != null">
				status = #{status},
			</if>
			<if test="productName != null">
				product_name = #{productName},
			</if>
			<if test="productId != null">
				product_id = #{productId},
			</if>
			<if test="cardNo != null">
				card_no = #{cardNo},
			</if>
			<if test="bankCode != null">
				bank_code = #{bankCode},
			</if>
			<if test="orderId != null">
				order_id = #{orderId},
			</if>
			<if test="effectiveDate != null">
				effective_date = #{effectiveDate},
			</if>
			<if test="redeemType != null">
				redeem_type = #{redeemType},
			</if>
			<if test="initAmount != null">
				init_amount = #{initAmount},
			</if>
			<if test="initEarning != null">
				init_earning = #{initEarning},
			</if>
			<if test="redeemingAmount != null">
				redeeming_amount = #{redeemingAmount},
			</if>
			<if test="redeemingEarning != null">
				redeeming_earning = #{redeemingEarning},
			</if>
			<if test="redeemedAmount != null">
				redeemed_amount = #{redeemedAmount},
			</if>
			<if test="redeemedEarning != null">
				redeemed_earning = #{redeemedEarning},
			</if>
			<if test="punishAmount != null">
				punish_amount = #{punishAmount},
			</if>
			<if test="latestRedeemTime != null">
				latest_redeem_time = #{latestRedeemTime},
			</if>
			<if test="maturityDate != null">
				maturity_date = #{maturityDate},
			</if>
			<if test="modifyTime != null">
				modify_time = #{modifyTime},
			</if>
			<if test="remark != null">
				remark = #{remark},
			</if>
		</set>

		<where>
			id = #{id} limit 1
		</where>
	</update>


	<!-- 根据ID进行查询 -->
	<select id="selectById" resultMap="AssetsResultMap">
		select * from assets where id = #{id}
	</select>


	<!-- 根据ID进行加行锁查询 -->
	<select id="selectByIdForUpdate" resultMap="AssetsResultMap">
		select * from assets where id = #{id} for update
	</select>


  	<!-- 根据查询条件查询数据和queryCountByParam方法配对使用 -->
  	<select id="queryListByParam" parameterType="map" resultMap="AssetsResultMap">
		SELECT 
			<include refid="_field_list"/>
		FROM 
			assets
		<where>
		 	1 = 1
			<include refid="_common_where"/>
			<include refid="_regin_where"/>
			<include refid="_contain_where"/>
		</where>

		<include refid="_common_sorts"/>

		<if test="offset != null and rows != null">
			limit #{offset}, #{rows}
		</if>
	</select>


	<!-- 根据查询条件查询总数和queryListByParam方法配对使用 -->
	<select id="queryCountByParam" parameterType="map" resultType="java.lang.Integer">
		SELECT count(1) FROM assets
		<where>
			1 = 1
			<include refid="_common_where"/>
			<include refid="_regin_where"/>
			<include refid="_contain_where"/>
		</where>
	</select>

</mapper>
out2012
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
mybatis Mapper.xml中传参多选 字符串形式逗号分隔 AND中拼接OR.rar
07-12
在实际开发中，你还需要在对应的Java接口和实现类中编写对应的方法，将前端传递的参数正确地绑定到Map对象中，并调用Mybatis的SqlSession执行查询。 总的来说，Mybatis提供了一套灵活的机制来处理动态SQL，包括处理...
mysql书写规范,mybatis.xml中sql编写规范
weixin_35944230的博客
03-23 321
mapperPUBLIC"-//mybatis.org//DTDMapper3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd">id,user_id,amount,earning,type,status,product_id,product_name,card_no,bank_code,order_id,effective_d...
【web开发】第16节：Mybatis：XML标签&动态SQL
最新发布
m0_46013789的博客
06-05 1099
MyBatis是一款优秀的持久层框架，用于简化JDBC的开发。我们做为后端程序开发人员，通常会使用Java程序来完成对数据库的操作。Java程序操作数据库，现在主流的方式是：Mybatis。
mybatis中sql 书写 规范 优化
耀的专栏
08-24 488
　规范 做注解 便于修改和优化 规范 <?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="com......dao (mapper)....."> <resultMap id="..
Mybatis在.xml文件中的SQL书写
qq_49799972的博客
02-06 3777
自定义SQL语句中需要关注的名词含义及其用法 mapper中的namespace的含义：namespace命名空间是指的mapper接口的全路径名，目的是为了保证SQL语句的唯一性。 <mapper namespace="com.mapper.XXXMapper"> resultMap以及其中type和id的含义：resultMap代表返回值数据库类型和Java类型的映射，type值为返回一个pojo对象，id为一个id结果，标记出作为id的结果可以帮助提高整体性能。 <resultM
myBatis xml文件SQL编写（ if、where、if-else、set 、foreach ）
廷赫斯的博客
03-09 8099
myBatis xml文件SQL编写（ if、where、if-else、set 、foreach ）1. if 标签2. where 标签3. choose, when, otherwise 标签 （if - else if - else ）4. set 标签5. foreach 标签 MyBatis 的强大特性之一便是它的动态 SQL。如果你有使用 JDBC 或其它类似框架的经验，你就能体会到根据不同条件拼接 SQL 语句的痛苦。例如拼接时要确保不能忘记添加必要的空格，还要注意去掉列表最后一个列名的逗
mybatis.docx
07-27
MyBatis 支持在 XML 映射文件中编写动态 SQL，如 `if`、`choose`、`when`、`otherwise`、`trim`、`where` 等标签，可以根据条件动态生成 SQL 语句。 7. **缓存机制**： MyBatis 内置了本地缓存（Local Cache）和...
02-mybatis.zip
10-07
- **XML映射文件**：在`mapper.xml`中编写SQL语句和结果映射，通过namespace与Mapper接口关联。 5. **增删改查操作** - **增（INSERT）**：在Mapper接口中声明插入方法，XML映射文件中编写对应的INSERT语句，通过...
spring boot + mybatis +mapper.xml 项目
10-30
4. **Mapper XML文件**: 在MyBatis中，Mapper.xml文件是SQL语句的载体，它定义了数据库操作，如增删查改。每个Mapper.xml文件通常对应一个Mapper接口，接口方法与XML中的SQL ID匹配，实现SQL的执行。 5. **MyBatis-...
Mybatis.rar
03-07
通过XML或注解的方式配置映射文件，Mybatis允许程序员直接控制SQL的编写，从而实现精确的数据操作。 在Mybatis中，SqlSessionFactory是整个框架的入口，它创建SqlSession对象，而SqlSession则负责执行SQL命令。配置...
mybatis xml文件自动生成
07-04
"mybatis xml文件自动生成"是开发过程中的一个重要环节，它可以帮助开发者提高效率，减少手动编写XML映射文件和对应的POJO（Plain Old Java Object）类的工作量。 MyBatis的Mapper文件是其核心组成部分之一，它包含...
mybatis根据数据库实体自动生成mapper.xml文件
03-27
在MyBatis中，Mapper接口和对应的Mapper XML文件是核心组成部分，它们定义了数据库操作的具体逻辑。本教程将指导你如何根据数据库实体自动创建Mapper XML文件。 1. **MyBatis Generator**: MyBatis Generator（MBG...
ssm-mybatis.zip )
03-20
Mybatis使得SQL编写更自由，能更好地应对复杂的数据库操作；Spring的DI和AOP简化了对象的管理和事务处理。 通过"ssm-mybatis.zip"这个项目，你可以快速地学习和理解SSM框架的工作原理，以及如何在实际开发中整合和...
mybatis联表查询mapper.xml
03-09
在`UserMapper.xml`文件中，可以编写如下SQL： ```xml <select id="selectUserWithOrders" resultType="com.example.User"> SELECT * FROM user u LEFT JOIN order o ON u.userId = o.userId ``` 这里使用了LEFT...
Mybatis基础知识总结（规范步骤）
weixin_53700782的博客
07-06 445
Myabtis规范步骤
【小技巧】MyBatis 中 SQL 写法技巧小总结
欢迎朋友，我是一名十多年开发经验的新手，希望多多指教。
11-19 560
【小技巧】MyBatis 中 SQL 写法技巧小总结
mybatis开发规范
村长在路上
02-02 1675
1.在mapper.xml中namespace等于mapper接口地址 2,mapper.java接口中的方法名和mapper.xml中的statement的id一致 3.mapper.java接口中的方法输入参数类型和mapper.xml中的statement的指定类型一致 4.mapper.java接口中的方法返回值和mapper.xml中statement的resultType指定的
mybatis.xml
05-16
MyBatis是一款Java持久层框架，支持自定义SQL、存储过程和高级映射。在使用MyBatis时，我们需要编写一个mybatis.xml文件来配置MyBatis的相关信息，例如数据源、Mapper接口映射等。 下面是一个简单的mybatis.xml配置文件示例： ```xml <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd"> <configuration> <environments default="development"> <environment id="development"> <transactionManager type="JDBC"/> <dataSource type="POOLED"> <property name="driver" value="com.mysql.jdbc.Driver"/> <property name="url" value="jdbc:mysql://localhost:3306/test"/> <property name="username" value="root"/> <property name="password" value="root"/> </dataSource> </environment> </environments> <mappers> <mapper resource="com/example/mapper/UserMapper.xml"/> <mapper class="com.example.mapper.OrderMapper"/> </mappers> </configuration> ``` 这个示例中，我们定义了一个数据源（dataSource），指定了数据库连接信息，包括数据库URL、用户名和密码。同时，我们还定义了两个Mapper，分别是UserMapper和OrderMapper，分别对应了两个Mapper接口的实现。这些Mapper的具体实现可以在对应的XML文件中进行定义。 除此之外，我们还可以在mybatis.xml文件中配置MyBatis的一些其他信息，例如缓存、插件等。在实际使用中，我们可以根据实际情况来灵活配置mybatis.xml文件，以满足我们的需求。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值