前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >编码规范

编码规范

作者头像
周杰伦本人
发布2022-10-25 15:13:19
4040
发布2022-10-25 15:13:19
举报
文章被收录于专栏:同步文章

第一章类注释

需要介绍类的详细说明(包括author) 示例

代码语言:javascript
复制
/**
 * 消息提醒处理
 * @author hcl
 */
@Service
public class MessageApiService {}

方法注释

需要介绍方法的功能、参数说明、返回值说明 示例

代码语言:javascript
复制
/**
* 执行提醒查询
* @param request 查询请求
* @return 提醒信息
*/
public MessageResponse query(MessageRequest request) {}

属性注释

需要说明属性的含义 示例

代码语言:javascript
复制
	/**
* 名称
*/
private String name;

注:使用/** */注释,不要使用//注释

第二章 命名

2.1类名

可用英文或者拼音,要见名知意,首字母大写,驼峰命名法 示例

代码语言:javascript
复制
/**
 * 展示信息
 * @author gengdh
 *
 */
public class QueryEntityMember {}

2.2方法名

可用英文或者拼音,要见名知意,首字母小写,驼峰命名法 示例

代码语言:javascript
复制
	/**
* 查询消息提醒内容
* @param request
* @return 提醒信息集
*/
private Map<String,Object> queryMessages(MessageRequest request)

2.3属性

可用英文或者拼音,要见名知意,首字母小写,驼峰命名法。若属性在数据库中没有相对应的字段,不要使用数据库字段命名方法命名属性,以免混淆。 示例

代码语言:javascript
复制
/**
* 类型
*/
private String type;

2.4常量名

常量命名全部大写,单词间用下划线隔开,要见名知意 示例

代码语言:javascript
复制
/**
* nested类型
*/
public final static String TYPE_NESTED="nested";

第三章 流

3.1关闭流 流的关闭,必须在finally里面用IOUtils类的方法关闭 示例

代码语言:javascript
复制
FileOutputStream out=null;
try {
	out=new FileOutputStream(new File(outputDir+"content.json"));
	json.writerWithDefaultPrettyPrinter().writeValue(out, contents);
			
}catch(Exception e) {
	throw new RuntimeException(e);
}finally{
	IOUtils.closeQuietly(out);
}

第四章 打印日志

4.1异常处理日志

出现异常情况需要使用error(String msg, Throwable t)方法打印日志。 示例

代码语言:javascript
复制
	try {
		List<MessageZf> zfs = msgs.getZfs();
		if(this.msgs == null||StringUtils.isBlank(this.msgs.getType())||zfs==null) {
				return;
		}
		for (MessageZf messageZf : zfs) {
			this.process(messageZf,this.msgs.getType());
		}
			
} catch (Exception e) {
		logger.error("消息提醒添加异常",e);
}

第五章 sql格式

5.1.格式样式

对于插入,更新,查询的sql格式需要简洁明了,#{}中需要写出jdbcType属性 示例

代码语言:javascript
复制
insert into DB_JY..T_INDEX_EVENT (	
ID,
	MAIN_ID,
	SRC_ID,
	SRC,
	ACTION,
	TASK_ID,
	CREATE_TIME,
	STATE,
	VALID,
	PARENT_ID
)
values (
	#{id,jdbcType=CHAR},
	#{mainId,jdbcType=VARCHAR},
	#{srcId,jdbcType=VARCHAR},
	#{src,jdbcType=VARCHAR},
	#{action,jdbcType=VARCHAR},
	#{taskId,jdbcType=VARCHAR},
	#{createTime,jdbcType=TIMESTAMP},
	#{state,jdbcType=INTEGER},
	#{valid,jdbcType=VARCHAR},
	#{parentId,jdbcType=VARCHAR}
)

5.2对于含有〉,〈的情况

对于含有大于和小于号的情况用<![CDATA[sql语句]]>形式书写 示例

代码语言:javascript
复制
	<![CDATA[
DELETE DB_JY..T_INDEX_EVENT
	WHERE
CREATE_TIME < #{createTime,jdbcType=TIMESTAMP} 
	AND STATE <=0
	]]>
本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2019-10-23,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 第一章类注释
    • 方法注释
      • 属性注释
      • 第二章 命名
        • 2.1类名
          • 2.2方法名
            • 2.3属性
              • 2.4常量名
              • 第三章 流
              • 第四章 打印日志
                • 4.1异常处理日志
                • 第五章 sql格式
                  • 5.1.格式样式
                    • 5.2对于含有〉,〈的情况
                    相关产品与服务
                    数据库
                    云数据库为企业提供了完善的关系型数据库、非关系型数据库、分析型数据库和数据库生态工具。您可以通过产品选择和组合搭建,轻松实现高可靠、高可用性、高性能等数据库需求。云数据库服务也可大幅减少您的运维工作量,更专注于业务发展,让企业一站式享受数据上云及分布式架构的技术红利!
                    领券
                    问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档