admin 管理员组

文章数量: 1086019


2024年3月13日发(作者：html目标选择器)

阿里巴巴编程规约

阿里巴巴编程规约

1. 命名规范

1.1 包名统一使用小写英文字母，不要使用纯数字或者连字符“-”。

1.2 类名、接口名和枚举名使用大写开头的驼峰命名法，尽量简洁明

了。

1.3 常量名和枚举常量名全部大写，单词之间用下划线“_”隔开。

1.4 方法名、参数名、局部变量名使用小写开头的驼峰命名法，尽量

简洁明了。

1.5 避免使用拼音或者其它语言的缩写作为命名。

2. 代码格式规范

2.1 缩进使用4个空格。

2.2 每行代码长度不超过120个字符。

2.3 大括号“{”和“}”不单独占用一行，左括号“{”和代码之间空

一格。

2.4 每行代码后留一个空格。

2.5 每个函数之间空一行。

2.6 函数内部代码优先使用局部变量。

3. 注释规范

3.1 类、接口和枚举使用Javadoc规范，包含作者、版本、描述等信

息。

3.2 方法和参数使用Javadoc规范进行注释。

3.3 方法内部的代码块使用单行注释“//”进行注释。

4. 异常处理规范

4.1 捕获异常后及时处理，不要忽略异常。

4.2 抛出异常时使用合适的异常类型。

4.3 不要在异常中使用日志输出语句，应该在异常外部进行处理。

5. 并发编程规范

5.1 尽量使用线程安全的类和方法。

5.2 避免使用死锁和饥饿等线程问题。

5.3 尽量减少同步块的长度。

5.4 使用线程池可以有效提高并发效率。

6. 安全规范

6.1 安全敏感信息不要明文出现在代码中。

6.2 避免SQL注入和XSS攻击。

6.3 代码中不要包含硬编码的密码或密钥等敏感信息。

6.4 不要向客户端返回过多的错误信息。

7. 性能优化规范

7.1 避免在循环中使用大的数据结构。

7.2 适度使用缓存、索引等工具来提高性能。

7.3 避免多余的对象创建和拷贝，使用StringBuilder等工具来提高

性能。

7.4 尽量避免使用反射和动态代理等技术。

8. 其他规范

8.1 不要随意更改已有的代码。

8.2 代码提交之前应该进行单元测试和代码检查。

8.3 不要出现重复的代码段，应该将其封装为函数或方法。

8.4 强烈建议使用版本控制工具管理代码。


本文标签： 使用 代码 规范 进行 避免

版权声明：本文标题：阿里巴巴编程规约 内容由网友自发贡献，该文观点仅代表作者本人， 转载请联系作者并注明出处：http://roclinux.cn/b/1710274584a565587.html， 本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容，一经查实，本站将立刻删除。