一些服务端写代码的规范,很重要

  对于设计的实现或者说代码的编写,有一些最基本的规则,或者说方法,现在梳理一下避免忘记。

  每个人的能力有差异,一个小组的水平参差不齐这就要求我们有些经验的总结,虽然是互联网公司

也要在快速迭代的同时保证程序的正确、方便验证、线上出问题快速定位问题,同时达到线上程序高可用,

可用性100%,性能优异。

一,项目建立

  1. 项目名称与实际业务名称一致为英文,易于后续维护理解。
  2. 项目结构采用经典spring结构模式,不做详细说明,可借鉴现有项目。
  3. 新项目建立依据实际业务,如业务为新增,可新建项目。
  4. 模块按照web、service、dao、common来设计。逻辑特别复杂的功能可通过包来进行规划。

二,编码原则

  1. 每个类只做一件事,所有的方法都应是和类直接相关的,和类没有关系的方法不应出现在类中。
  2. 单个方法代码行数避免过长,过长要进行拆分,一般长度建议在30行以内,特殊情况如方法只做一件事例如:初始化bean多个字段,可被允许。
  3. 代码日志要符合级别error在error输出,error一定要输出栈信息,logger.log(e.getmessage(),e),当出现问题能很快定位问题。error就是error出现了就是系统出现问题了,避免由于输出了很多非error信息错过真正error,对于中间件或通用性高级别的代码需要对error进行编号,以便能有程序方便对日志进行扫描统计。
  4. 单元测试使用原则,单元测试不能太细,太细会变得及其琐碎,一般的逻辑不建议编写测试用例,应在编码时保证逻辑是没问题的,太多的单元测试会导致浪费大量时间维护单元测试,得不偿失,复杂逻辑应单元测试,单元测试可以保证逻辑的正确性、完整性甚至还可以发现需求的完整性与合理性,合适的使用单元测试能保证逻辑正确,并能倒逼给出更好编码实现。
  5. 代码返回值的监控,对于100%线上可用系统很有必要,能够及时发现问题,避免问题出了不知道,需要下游提醒才知道。监控力度要准确合理。
  6. error线上代码应尽量避免抛异常,如抛异常应同时发报警,抛异常一般建议在jar包中使用,调用方可以根据异常进行报警或相应处理,可以保证返回结果不用考虑异常问题。
  7. 内存缓存的使用,要清楚了解每个配置项的意义,避免错误使用导致线上问题。
  8. 所有redis key要写常量文件里面,如程序生成要将整个项目的所有redis 取数逻辑写在一定地方。方便查找管理。
  9. 调用第三方接口要做异常检查以及通过ump对接口性能进行监控。
  10. 调用同一个redis的多个key,可以通过mget一次调用多个key,避免每个key一次调用,由于多次io导致性能变差,一次调用可显著提升性能。
  11. 第三方工具、组件使用时要尽量去详细了解,避免对工具、组件不了解引入问题。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏我是攻城师

ElasticSearch里面的路由功能介绍

2877
来自专栏芋道源码1024

游戏开发 —— 协议设计

语义:解释控制信息每个部分的意义。它规定了需要发出何种控制信息,以及完成的动作与做出什么样的响应。

750
来自专栏我是攻城师

5行代码怎么实现Hadoop的WordCount?

2927
来自专栏乐享123

Send Large Packet by Dpdk Pktgen

1383
来自专栏用户2442861的专栏

基于protobuf的RPC实现

http://blog.csdn.net/kevinlynx/article/details/39379957

533
来自专栏流柯技术学院

Monkey测试2——Monkey测试策略

Monkey的测试策略 一. 分类 Monkey测试针对不同的对象和不同的目的采用不同的测试方案,首先测试的对象、目的及类型如下: 测试的类型分为:应用...

673
来自专栏H2Cloud

C++中消息自动派发之三 About JSON Encode

  《C++ 消息自动派发》系列上篇介绍了IDL解析器,生成的C++代码只支持JSON转C++ struct。 经过新的重构,这次增加了对C++ struct ...

3685
来自专栏wblearn

redis应用的总结

对最近项目应用redis做一个简单总结,项目中的营业网点资料和客户资料等模块以后的资料量势必会随着业务的扩张会越来越大,可能会造成系统性能瓶颈及用户体验不佳等,...

591
来自专栏数据结构与算法

BZOJ4006: [JLOI2015]管道连接(斯坦纳树,状压DP)

1621
来自专栏Kirito的技术分享

从Spring Session源码看Session机制的实现细节

去年我曾经写过几篇和 Spring Session 相关的文章,从一个未接触过 Spring Session 的初学者视角介绍了 Spring Session ...

49612

扫码关注云+社区