【公共规范】注释！必须要有详细的注释！ 要求： 必须有详细的注释（空） 每个类（文件）必须注释清楚： 设计目的 使用场景 使用方式甚至使用样例 注意事项 每个属性、常量都要有注释。当语言支持的时候，常

【公共规范】要使用成熟的工具类，不要自己擅自且重复“造轮子” 所有的非专有算法，先问如下问题： 1、我是不是第一个需要这样功能的人？我是不是第一个发现有这个功能需求的人？ 2、这个功能是不是很特殊，没有重用意义，因此世界上其他人都不会为此写一个“轮子”，需要我自己造？

【公共规范】URI规范 首先来看一下URI的格式：URI = scheme://authority/path[?query][#fragment ] 1、使用"/"来分割层级，并且层级不要超过三级 【建议】 2、全部使用小写，不能使用大写(包括驼峰) 【强制】，反例：/api/getUserList

【公共规范】严禁忽略流式编程中的任何返回值（如map函数） 无论任何语言或者工具库中，map的含义都是将A转换成B，即map=A->B 这里的返回值B是A经过逻辑处理后的返回值，是一定有用的，不可以直接忽略，更不能拿来当循环使用！

【公共规范】写代码（算法）时一定要注意生产环境与开发、测试时的不同 下面列举一下，逐步补充：

【公共规范】严禁复制粘贴代码 描述一下主要场景： 之前我（别人）写了一段代码，跟现在的一样（差不多），可以拷贝过来改一下（或则不用改）变量名（方法名）就可以用了 手工重复输入相同的代码，或者相似的代码 网上找了一段人家的代码，虽然我不懂，但是拷贝过来就能用了 以上情况均不允许，基本原则是： 当你按下

【公共规范】严禁在同一个函数中反复通过方法调用访问成员属性 如： public void example() { final String userName = UserContext.getUser().getUserName(); final Long userId = User

【公共规范】严禁写if (true) then true样式的代码 这个没啥好说的，直接上代码吧： public boolean example(final boolean condition, final User user) { // 1、 obj.isEnable = cond

【公共规范】严禁使用含分隔符的多值字符串查找的方式判断值是否存在 如： private static final String JAVA_MENU = "develop/guide/java"; public boolean inMenu(final String menuNa

【公共规范】严禁对配置项进行硬编码 严禁将任何在程序生命周期内可能变化的配置硬编码在代码里，包括但不限于： 协议、IP（域名）、端口、路径、参数； 目标文件名 用户名、密码 名称、代号、编码 ...... 即使有缺省值，缺省值也要在配置文件中提供。否则当配置信息出现变动时就必须改动代码，而改动代码就