我是「猿码天地」,一个热爱技术、热爱编程的IT猿。技术是开源的,知识是共享的!
写作是对自己学习的总结和记录,如果您对 Java、分布式、微服务、中间件、Spring Boot、Spring Cloud等技术感兴趣,可以关注我的动态,我们一起学习,一起成长!
用知识改变命运,让家人过上更好的生活,互联网人一家亲!
——公众号《猿码天地》
代码不规范,同事两行泪!
现代软件行业的高速发展对开发者的综合素质要求越来越高, 因为不仅是编程知识点,其它维度的知识点也会影响到软件的最终交付质量。比如:数据库的表结构和索引设计缺陷可能带来软件上的架构缺陷或性能风险;工程结构混乱导致后续维护艰难;没有鉴权的漏洞代码易被黑客攻击等等。代码规范,是为确保软件代码能被系统正确运行,软件编写者或其他参与者能正确理解、维护软件代码,换句话说,就是增强代码的易用性、可读性、可维护性、安全性等要求。
废话不多说,直接上干货!
一、代码编写规范
业界公认的代码规范手册(国内)当属阿里巴巴旗下出版的《阿里巴巴java开发手册》,经过几个版本的迭代,最新手册为《“码出高效” 阿里巴巴java开发手册1.4.0版本》,更新时间为2018年5月20号。手册以 Java 开发者为中心视角,划分为编程规约、异常日志、 单元测试、 安全规约、 MySQL 数据库、 工程结构、 设计规约七个维度,再根据内容特征,细分成若干二级子目录。根据约束力强弱及故障敏感性,规约依次分为强制、推荐、参考三大类。对于规约条目的延伸信息中,“说明” 对规约做了适当扩展和解释;“正例” 提倡什么样的编码和实现方式;“反例”说明需要提防的雷区, 以及真实的错误案例。
阿里巴巴java开发手册目录:(可在文末获取手册文档)
另外也可以学习《唯品会Java开发手册》,该手册是基于《阿里巴巴java开发手册》改编。该开发手册主要从格式规约、注释规约、方法设计、类设计、控制语句、基本类型、集合处理、并发处理、异常处理、日志规约、其他设计等几个维度进行说明与规范。
唯品会Java开发手册目录:(可在文末获取手册文档)
二、统一代码格式
多人协作开发时时常会出现你爱 Tab 他爱空格,你缩进 2 个字符,别人缩进 4 个字符的问题,还有换行符乱码、文章末尾空行、注释不规范、编码不规范等。同时,不同编辑器对缩进处理方法迥异,如何解决?接着往下看。
这里使用Idea工具为例(eclipse配置方法一样)
1、打开Idea设置Settings -》选择Editor-》Code Style,选择import,导入xml文件。ÿ