代码名命规范浅析

日常开发编码中，代码的名命是个大学问，能快速的看懂开源代码的结构和意图，也是一项必备的能力。在java项目的代码结构中，采用长名命的方式来规范类的名命，能够自己表达其主要意图，配合高级IDE，可以减少编码攻城狮的记忆负担，靠模糊匹配就能找到所需的资源。

借鉴最流行的java开源软件的源码，如netty、spring，guava等，以不同类的方式进行分析和归纳，希望能帮助搭建更好的理解名命的套路。

1、管理类名命

写代码，少不了对资源的管理，清晰的启动过程可以有效的组织代码。

Bootstrap、Starter

一般作为程序启动器使用，或者作为启动器的基类。通俗来说，可以认为是main函数的入口。

AbstractBootstrap
ServerBootstrap
MacosXApplicationStarter
           

Processor

某一类功能的处理器，用来表示某个处理过程，是一系列代码片段的集合。

MappingProcessor
           

Manager

对有生命状态的对象进行管理，通常作为某一类资源的管理入口。

TransactionManager
           

Holder

表示持有某个或者某类对象的引用，并可以对其进行统一管理。多见于不好回收的内存统一处理，或者一些全局集合容器的缓存。

ViewHolder
           

Factory

工厂模式的命名，尤其是在Spring中，多不胜数。

SessionFactory
           

Provider

Provider = Strategy + Factory Method。它更高级一些，把策略模式和方法工厂揉在了一块，让人用起来很顺手。Provider一般是接口或者抽象类，以便能够完成子实现。

AuthenticationProvider
           

Registrar

注册并管理一系列资源。

CryptoServicesRegistrar
           

Engine

一般是核心模块，用来处理一类功能。引擎是个非常高级的名词，一般的类是没有资格用它的。

StandardEngine
           

Service

某个服务，数不胜数。

PersistenceService
           

Task

某个任务，通常是个runnable。

ForkJoinTask
           

2、传播类名命

为了完成一些统计类或者全局类的功能，有些参数需要一传到底。传播类的对象就可以通过统一封装的方式进行传递，并在合适的地方进行拷贝或者更新。

Context

如果你的程序执行，有一些变量，需要从函数执行的入口开始，一直传到大量子函数执行完毕之后。这些变量或者集合，如果以参数的形式传递，将会让代码变得冗长无比。这个时候，你就可以把变量统一塞到Context里面，以单个对象的形式进行传递。

ApplicationContext
           

Propagator

传播，繁殖。用来将context中传递的值进行复制，添加，清除，重置，检索，恢复等动作。通常，它会提供一个叫做propagate的方法，实现真正的变量管理。

TransactionPropagator
           

3、回调类名命

使用多核可以增加程序运行的效率，不可避免的引入异步化。这时需要有一定的手段，获取异步任务执行的结果，对任务执行过程中的关键点进行检查。回调类API可以通过监听、通知等形式，获取这些事件。

Handler、Callback、Trigger、Listener

Handler通常表示持有真正消息处理逻辑的对象，它是有状态的；Callback通常是一个接口，用于响应某类消息，进行后续处理；Trigger触发器代表某类事件的处理，属于Handler，通常不会出现在类的命名中；Listener的应用更加局限，通常在观察者模式中用来表示特定的含义。

ChannelHandler
SuccessCallback
CronTrigger
EventListener
           

Aware

Aware是感知的意思，一般以该单词结尾的类，都实现了Aware接口。拿spring来说，Aware 的目的是为了让bean获取spring容器的服务。具体回调方法由子类实现，比如ApplicationContextAware。

ApplicationContextAware
           

4、监控类名命

Metric

表示监控数据，不要用Monitor了，比较丑。

HistogramMetric
           

Estimator

用于计算某一类统计数值的计算器。

ConditionalDensityEstimator
           

Accumulator

累加器的意思，用来缓存累加的中间计算结果，并提供读取通道。

AbstractAccumulator
           

Tracker

一般用于记录日志或者监控值。

PerformanceTracker
           

5、内存管理类名命

如果你的应用用到了自定义的内存管理，那么下面这些名词是绕不开的。比如Netty，就实现了自己的内存管理机制。

Allocator

与存储相关，通常表示内存分配器或者管理器。

ArrayAllocator
           

Pool

表示池子，内存池，线程池，连接池，池池可用。

ConnectionPool
           

6、过滤监测类名命

程序收到的事件和信息是非常多的，有些是合法的，有些需要过滤扔掉。根据不同的使用范围和功能性差别，过滤操作也有多种形式。你会在框架类代码中发现大量这样的名词。

Pipeline、Chain

一般用在责任链模式中。Netty，Spring MVC，Tomcat等都有大量应用。通过将某个处理过程加入到责任链的某个位置中，就可以接收前面处理过程的结果，强制添加或者改变某些功能。就像Linux的管道操作一样，最终构造出想要的结果。

Pipeline
           

Filter

过滤器，用来筛选某些满足条件的数据集，或者在满足某些条件的时候执行一部分逻辑。如果和责任链连接起来，则通常能够实现多级的过滤。

CorsFilter
           

Interceptor

拦截器，其实和Filter差不多。不过在Tomcat中，Interceptor可以拿到controller对象，但filter不行。拦截器是被包裹在过滤器中。

HttpRequestInterceptor
           

Evaluator

评估器的意思，可用于判断某些条件是否成立，一般内部方法evaluate会返回bool类型。比如你传递进去一个非常复杂的对象，或者字符串，进行正确与否的判断。

ArithmeticExpressionEvaluator
           

Detector

探测器，用来管理一系列探测性事件，并在发生的时候能够进行捕获和响应。

XMLVersionDetector
FileTypeDetector
           

7、结构类名命

除了基本的数据结构，如数组、链表、队列、栈等，其他更高一层的常见抽象类，能够大量减少大家的交流，并能封装常见的变化。

Cache

缓存。

EhCacheCache
           

Buffer

buffer是缓冲，不同于缓存，它一般用在数据写入阶段。

ByteBuffer
           

Wrapper

用来包装某个对象，做一些额外的处理，以便增加或者去掉某些功能。

ResponseWrapper
           

Option、Param、Attribute

用来表示配置信息。说实话，它和Properties的区别并不大，但由于Option通常是一个类，所以功能可以扩展的更强大一些。它通常比Config的级别更小，关注的也是单个属性的值。Param一般是作为参数存在，对象生成的速度要快一些。

SelectOption
           

Aggregator

聚合器，可以做一些聚合计算。比如分库分表中的sum，max，min等聚合函数的汇集。

PipelineAggregator
           

Iterator

迭代器，可以实现java的迭代器接口，也可以有自己的迭代方式。

StringCharacterIterator
           

Batch

某些可以批量执行的请求或者对象。

BatchRequest
           

Limiter

限流器，使用漏桶算法或者令牌桶来完成平滑的限流。

RateLimiter
           

8、设计模式类名命

Strategy

将抽象部分与它的实现部分分离，使它们都可以独立地变化。策略模式，相同接口，不同实现类，同一方法结果不同，实现策略不同。比如一个配置文件，是放在xml里，还是放在json文件里，都可以使用不同的provider去命名。

BufferStrategy
           

Adapter

将一个类的接口转换为客户希望的另一个接口，Adapter模式使得原本由于接口不兼容而不能一起工作的那些类一起工作。

AuthorizationServerConfigurerAdapter
           

Event

表示一系列事件。

KeyEvent
           

Delegate

代理或者委托模式，委托模式是将一件属于委托者做的事情，交给另外一个被委托者来处理。

MenuDelegate
           

Builder

将一个复杂对象的构建与它的表示分离，使得同样的构建过程可以创建不同的表示。

JsonBuilder
           

Template

模板方法类的命名。定义一个操作中的算法的骨架，而将一些步骤延迟到子类中。模板方法使得子类可以不改变一个算法的结构即可重定义该算法的某些特定步骤。

JDBCTemplate
           

Proxy

代理模式，为其他对象提供一种代理以控制对这个对象的访问。

ProxyFactory 
           

9、解析类命名

写代码要涉及到大量的字符串解析、日期解析、对象转换等。根据语义和使用场合的区别，它们也分为多种。

Converter、Resolver

转换和解析。一般用于不同对象之间的格式转换，把一类对象转换成另一类。注意它们语义上的区别，一般特别复杂的转换或者有加载过程的需求，可以使用Resolver。

DataSetToListConverter
InitRefResolver
           

Parser

用来表示非常复杂的解析器。

JSONParser
           

Customizer

用来表示对某个对象进行特别的配置。由于这些配置过程特别的复杂，值得单独提取出来进行自定义设置。

ContextCustomizer
           

Formatter

格式化类，主要用于字符串、数字或者日期的格式化处理工作。

SimpleDateFormat
           

10、网络类命名

Packet

通常用于网络编程中的数据包。

DatagramPacket
           

Protocol

用户网络编程中，用来表示某个协议。

HttpProtocol
           

Encoder、Decoder、Codec

编码解码器

RedisEncoder
RedisDecoder
RedisCodec
           

Request、Response

一般用于网络请求的进和出。如果你用在非网络请求的方法上，会显得很怪异。

Util、Helper

都表示工具类，Util一般是无状态的，Helper以便需要创建实例才能使用。

HttpUtil
TestKeyFieldHelper
           

Invoker、Invocation

invoker是一类接口，通常会以反射或者触发的方式，执行一些具体的业务逻辑。通过抽象出invoke方法，可以在invoke执行之前对入参进行记录或者处理；在invoke执行之后对结果和异常进行处理，是AOP中常见的操作方式。

MethodInvoker
ConstructorInvocation
           

注：名命是编码中非常重要的一环，希望大家能够找到其中的规律，让你的代码功能强大且优雅。