业务代码编写规范标准

1、关于mq业务使用规范:

  • a)、virtual host 命名根据业务模块来(例如成交,virtual host=dealinvite)
  • b)、队列命名,第一选项根据业务分类,第二阶段 功能模块,第三阶段动作(例如:成交邀约阶段系统消息未读推送,dealinvite.message.system.noread)
  • c)、业务消息消费统一写在相应的业务模块下的mq。(例如,成交模块,dealinvite_mq)
  • d)、现有的mq服务 统一走java bean注解,不要在xml文件配置注解。
  • e)、重要的业务模块消费失败的消息一定要备份起来。(涉及到金钱)
  • f)、mq队列命名资源无需写在配置文件中。
  • g)、mq消费失败的异常不要捕获直接丢弃给框架处理。
  • h)、mq的消费者和生产者必须在同一个业务分类下进行。

2、关于redis使用规范:

  • a)、key值命名规范,第一选项根据业务分类,第二阶段 功能模块,第三阶段动作。(成交邀约阶段车主手机号码标记,dealinvite:caruser:auctionId:mobile:)
  • b)、所有的key必须有生命周期,最长的时间不超过7天,视具体情况定。(设置TTL过期时间)

3、关于job任务使用规范:

  • a)、单个sql执行的时间尽量控制到120ms范围标准。
  • b)、单个sql执行的返回结果集最大不能超过200条。
  • c)、job任务描述项尽可能详细清晰。
  • d)、一次性消费job使用完毕后需要回收,不能使用表达式做下线。
  • e)、cron表达式发生修改,一定要在配置文件中进行调整,不要直接通过es-job控制台直接操作。

4、关于系统日志消息使用规范:

  • a)、按照日志等级输出要求来定义输出日志(消息输出的:info,错误日志:error)。
  • b)、对日志输出需要进行过滤,与业务无关的消息体不要做输出。(400~600之间的业务状态信息需要处理,那么区间外的业务信息就不要输出)
  • c)、输出的日志要有意义,没有必要对所有的结果都做输出操作,记录输出有意义的结果。
  • d)、错误的业务日志一定要输出,对系统的运行的错误信息,以及自定义异常信息都要进行输出。

5、业务代码编写规范:

  • a)、所有的输入参数使用前都必须进行非空判断。
  • b)、外部的接口或者内部微服务调用需要有重试补偿机制,以及失败处理机制。
  • c)、微服务客户端调用必须接入熔断机制,服务端需要提供熔断限制。
  • d)、业务代码编写公共方法不能有else if的逻辑判断。
  • e)、业务代码调用链单一层级深度限制在5以内。
  • f)、老的业务代码开发或者问题修复,如果涉及多方调用,需要将当前的调用链单独剥离出来。

6、DAO层SQL规范

  • a)、sql尽量减少数据库函数的使用,在查询方面能够提示效率。
  • b)、sql层尽可能的少业务逻辑判断。
  • c)、sql的函数和service的函数一对一实现。

 

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
### 回答1: IT业务详细说明书编写规范是指在IT项目管理过程中,编写详细说明书的规范化要求。这些规范包括以下方面: 1.概述:包括项目目标、背景、范围、需求等。 2.需求分析:包括用户需求、功能需求、性能需求、灵活性需求等。 3.系统设计:包括技术架构、数据流程、数据库设计等。 4.开发及测试:包括开发环境、测试环境、测试计划、测试结果等。 5.安装及运行:包括安装步骤、操作规范、维护说明等。 在编写详细说明书时,应注意以下要点: 1.内容必须清晰、详细、准确,以便于开发团队实施。 2.语言简洁明了,不要出现歧义、模棱两可的表述。 3.避免重复或冗余信息,避免车前马后的描述。 4.合理运用图表、流程图等辅助说明,使内容更加亲切。 5.要有明确的模板和格式,以确保规范化和一致性。 IT业务详细说明书编写规范能够提高IT系统开发的效率和质量,减少开发过程中的错误和风险,帮助IT项目团队更好地合作和沟通,保障项目的成功运行。 ### 回答2: IT业务详细说明书编写规范是指编写IT业务详细说明书时需要遵守的各种规范标准。IT业务详细说明书是一种书面文档,用于记录IT业务的详细信息和规范,包括业务需求、工作流程、技术实现、测试计划等内容,旨在为开发团队提供清晰的指导,确保项目能够按照计划完成。 首先,IT业务详细说明书应该有一个清晰的结构,包括正文、附录和参考资料。正文应该按照需求分析、系统设计、开发实现、测试计划和上线维护等顺序进行组织,以确保整个文档的逻辑性和可读性。附录应该包括任何必要的细节信息,如各种表格、图片、代码片段等。参考资料应该列出所有使用过的文献和软件包,以便其他人可以追溯到文档的来源和依赖关系。 其次,IT业务详细说明书应该采用专业术语和表述,以确保文档的准确性和可描述性。应该尽可能避免使用不必要的术语缩写和技术语言,以确保文档的易读性和理解性。 再次,IT业务详细说明书应该设置清晰的标准规范,以确保文档的一致性和完整性。例如,应该有一致的命名规则和格式,以确保文档中的各个部分具有相同的格式和排列方式,从而让文档更易读和理解。 最后,IT业务详细说明书应该由专业的技术人员编写和审查,以确保文档的准确性和可靠性。应该有充足的时间和资源来编写和审查文档,以确保文档的质量和可用性。同时,要注意保护文档的机密性,以避免敏感信息的泄露。 ### 回答3: IT业务详细说明书是IT项目中重要的一环,它主要是为了确保项目团队成员在开发过程中能够理解和遵守相应的需求和规范,确保项目最终能够实现预期的目标和效果。因此,编写IT业务详细说明书需要遵循以下规范: 1.明确需求:编写IT业务详细说明书之前必须要对需求进行充分的分析和理解,确保需要编写的内容与实际需求一致。 2.规范格式:编写IT业务详细说明书需要按照预定的格式进行,确保文件的整洁、易读性、易维护性和易于组织。 3.简明扼要:在编写IT业务详细说明书时,需要保持语言简洁、明确,避免使用繁琐的术语和复杂的表述方式,让读者容易理解。 4.明确分工:编写IT业务详细说明书需要明确分工,确保每个小节的内容由特定的人来编写,避免出现重复、不一致或遗漏的情况。 5.确保准确性:编写IT业务详细说明书需要确保内容的准确性和完整性。必要时,可以进行多次审核和校对,确保文件质量得到保障。 6.及时更新:IT业务详细说明书是一个“动态”的文档,需要及时更新,确保项目的进度和相关需求得到及时反应和调整。 总之,在编写IT业务详细说明书时,需要注重细节、全面性和可行性,确保文档质量得到保障,保证项目目标得到顺利实现。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

山不在高_有仙则灵

你的奖励是我的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值