如何让写的代码达到开源的标准
不管工作几年能够写得一手优秀的代码那肯定是非常吃香的。怎样的代码才能够算的上优秀？业界还真没有一个评判标准，在开发人员每个阶段的代码的认知都是不一样的，跟工作经历和工作经验息息相关，每个人都有自己主观的评判标准，有可能昨天你觉得很优秀的代码今天依然看着很low；一个工作经验丰富的人看新人写的代码，心情也是各种复杂。
最近一段时间总结一些代码评判标准的一些看法，当然这也只是我自己的理解，能够更靠近标准。可以用一个公式表达：标准代码=场景+基础知识+设计原则+设计模式+注释+单元测试+工作经验；别看这只是一个简单的公式，消化起来也得花上几年的时间。
场景化
所有的代码不可能凭空产生，首先我们要清楚前提是一个什么场景，这个场景有哪些需求，每个需求有哪些功能点；代码开始做设计的时候需要知道具体的场景，代码重构的时候也需要知道具体的场景；现实有很多这样的情况，项目的周期很长，维护项目的人一波又一波，到最后都不知道这些代码什么这么写，出现问题了也只关注局部，解决当前问题；很少考虑到源头什么去这么做，这个问题有可能引起哪些问题，如果需要重构的话有什么优化手段。
说到底就是怎么维护场景和代码的关系，通过场景知道代码实现，根据代码实现找到具体的场景；详细设计文档的作用就体现出来了；详细设计文档主要记录场景说明，前置步骤、触发条件，时序图、类图、接口输入输出；那这样又会带来一个问题，谁去维护详细设计文档维护文档是一个比较索而无味的事情，一些程序员宁愿写代码也不愿意写文档，所以还是需要有负责人去维护。
基础知识
代码基础知识是一个程序员的基石，不用多说，大家都懂；但是还是需要时常去回顾一下，以前学习的时候是学怎么用？而现在我们需要考虑的是为什么需要这样用！能给我们带来什么好处，用这些基础知识能解决那些问题。一般场景的就是封装、集成、抽象、多态、面向对象、面向接口的知识。
设计原则
设计原则可以说是比较实在的东西的，可以作为一种代码设计和评审的重要依据；一些叫有规模的项目在设计的时候都会去遵循这一套设计原则，那我们常说的设计原则有哪些呢？SOLID原则
SRP: Single Responsibility Principle,一个类或者模块只负责完成一个职责；
OCP：Open Closed Principle，软件实体（模块、类、方法等）应该“对扩展开发，对修改关闭”；
LSP：Liskov Substitution Principle，子对象能够替换程序中父类对象出现的任何地方，并且保证原来的程序逻辑行为不变及正确性不被破坏；
ISP: Interface Segregation Principle,客户端应该不强迫依赖它不需要的接口；
DIP：Dependency Inversion Principle，高层模块不要依赖底层模块，高层模块和底层模块之间应该通过抽象来相互依赖，除此之外，抽象不要依赖具体的实现细节，具体实现细节依赖抽象。
KISS原则：KISS=Keep It Short and Simple.（尽量保持简单。）
YAGNI原则：You Ain’t Gonna Need It.（不要做过度设计。）
DRY原则：Don’t Repeat Yourself.（不要写重复的代码。）
设计模式
设计模式的产生是基于设计原则的，如果说设计原则是代码标准，那么设计模式就是基于设计原则的工具类，也是对设计原则的最佳实践。我们常听的23种设计模式也是分别解决不同场景下的代码论；那是不是就只有23种设计模式呢？显示不是的，只能说这23种设计模式覆盖大部分场景，自己也可以创建一种设计模式。随着时间的推移23种设计模式已经成为了标杆，23种设计模式主要是哪些？
创建型：代理模式、工厂模式、建造者模式、原型模式；
结构型：代理模式、适配器模式、桥接模式、门面模式、装饰器模式、组合模式、享元模式
行为型：观察者模式、迭代器模式、命令模式、模板模式、状态模式、解释器模式、策略模式、访问者模式、中介模式、责任链模式、备忘录模式；
注释
注释是项目开发过程中非常重要的一个环节，我经历了很多项目，真正能把注释落地而且规范的是比较少的，在我个人看来，我们开发的项目和开源的项目来开距离的就是注释。我们开发的项目的注解是怎么样的呢？类注释会简单的描述类的作用，基本一句话总结，也会加上日期、作者之类的；方法也是类似；而且很多时候是开发的时候不会去写注释，在开发完成之后在去补充对应的注释，对于小白来说，很难通过这些注解知道一些细节性的东西，只能通过代码查看。对于开源项目是怎么做的呢？我们以Spring框架来举例，第一点类上面的注释非常详细，主要包含这个类是做什么的、有哪些配置、这个类关联了哪些类，这个类有哪些主要方法，最重要的是还有示例代码，通过html标签的形式展示，也方便javadoc查阅，当我们查看注释文档的时候，而不看代码我们就知道这个类的大致设计。这方面的差距还是需要多看源码来弥补的。
单元测试
单元测试是保证代码质量的的一种实现方式，但是大家都不愿意写单元测试，比较麻烦还比较耗时；之前经历过一些项目，那都是迭代周期比较短，几天时间从设计开发、测试、上线，基本上是没有多余的事情去做单测；还有一种情况就是行为方式，习惯了手动测试的方式，以最终运行的结果为准。这样会带来一些弊端，第一：场景覆盖不全，手工测试，需要创造各种场景，而且有些情况不一定能够模拟出来，测试的周期将会更长，到测试问题有转开发，实际上周期会拉长；第二点：当新增或者是修改功能的时候，需要将之前的功能从新手动跑一次，也会加长整个开发周期。建议呢，在项目中必须要养成写单元测试的习惯，不仅能够检验逻辑的正确性，也能够减少整个开发周期带来的额外的时间。
工作经验
工作经历越长经历的各种场景也就越多，深受不规范带来的坑的痛苦，他们会刻意的避免一些坑，注重一些代码规模，像阿里的开发手册规范，就是积累了很多前辈的心血，也是很多前辈踩过的坑。工作经历长的人会注重代码优化和并发问题，举个例子：在Spring的bean组件定义全局变量，然后再方法里面去修改值，有经验的人一样就会看出来会有并发问题，因为bean组件是单例，并发场景下多有多个线程去修改，导致线程不安全。工作年限久的不一定比刚出来的人掌握的知识多，但他遇过的坑肯定是你多的，所有积累项目经验，想前辈学习也是重要的过程。
总结语
每个人在每个阶段的对代码的理解程度是不一样的，同一样的代码在不同的时间感悟也是不一样的，在真正理解代码的程度上；代码里开源标准也就不远了；所以说项目要达到开源指标，还是有一些难度，也就是需要被大多数使用者理解的代码才算是真正的开源标准。
扫码二维码
获取更多精彩
java圈
点下在看，你最好看