一份 Java 常用命名梳理(摘自;掘金-uzong)

摘了自用,侵删

一、变量

下面是很多源码中也经常出现的命名前缀后缀,希望通过这种方式,对日常编程命名有一定参考价值!

命名案例描述
xxxContextRpcRequestContext、ServletContext应用上下文,整个调用方法链条;作用域较大、生命周期长,能承载较多信息
xxxHolderBeanDefinitionHolder持有者,拥有某一个对象;理论上,xxxHolder 对象不具备行为能力,只提供xxx信息和一些相关附加信息
xxxHandlerResultHandler、ParameterHandler、StatementHandler、MessageHandler指某种处理器或处理程序,其主要职责是处理特定类型的事件或任务
xxxProcessordataProcessor功能的处理过程
xxxActiondeleteAction行为
xxxFilterConvertFilter过滤器
xxxInterceptorUpdateInterceptor拦截器
xxxPipelineservicePipeline管道、责任链中使用
xxxChainFilterChain链条、责任链中使用
xxxChannelSocketChannel通道
xxxRequesthttpRequest请求体,包含内容多
xxxResponsehttResponse请求返回,包含内容多
xxxParamTeamParam请求参数
xxxRegistryMapperRegistry注册资源,以及管理他们
xxxFactoryCarProductFactory生命生产工厂
xxxProxyFactoryAopProxyFactory代理工程等
xxxBuilderstringBuilder构造器
xxxCreatorreportCreator创造者
xxxProcessordataProcessor处理器
xxxConverterjsonConverter转换器,从一种状态转换成另外一种状态、或者数据格式等
xxxCallbackcompletionCallback方法回调
xxxTask/ xxxJobbackTask/backJob特定任务
xxxManagerUserManager、TaskManager、ConfigruationManager对有生命状态的对象进行管理;通常用于封装业务逻辑或处理复杂操作的类
xxxUtilcacheUtil工具类
xxxHelperbizHelper助手,协助完成
xxxResourceimageResource特定资源
xxxConfigappConfig配置
xxxExceptionBizException异常
xxxBufferStringBuffer缓冲区
xxxListenerActionListener监听者,响应事件或变化
xxxPoolConnectionPool连接池
xxxParserXmlParser解析器,什么的解析
xxxEngineWorkflowEngin比如流程引擎,非常核心的类
xxxBootstrapAppBootstrap框架的启动类
xxxGatewayApiGateway网关
xxxLoaderResourceLoader加载器
xxxAdapterhttpAdapter适配
xxxValidatorParamValidator校验器
xxxLayerDatabaseAdapterLayer层级,比如 ETL
xxxProducer /xxxConsumerKafkaProducer生成者、消费者
xxxPluginCompilerPlugin插件
xxxClientTransportClient客户端
xxxApplicationDemoApplication应用入口
isXXX / hasXXX, canXXXisEnabled, hasError, canEditboolean 类型的状态; 布尔相关的命名加上 is、can、should、has 等前缀。
defaultXXXdefaultInvokerService默认什么的处理器
assembleXXXassembleCar组装、收集、聚集
customXXXcustomDataSource自定义类
IllegalXXXIllegalException非法,如非法异常
tryXXXtryRelease尝试,不保证成功

二、模式

设计模式是编程中经常遇见的,通过命名能快速确定设计模式,对于阅读代码非常有帮助。

以下是部分常见的设计模式的命名方式,不是强制性的命名规范。

模式名称常见前后缀具体例子和中文注释
单例模式SingletonDatabaseSingleton - 数据库连接的单例实例。
工厂方法FactoryCarFactory - 创建不同类型的汽车对象。
抽象工厂AbstractFactoryFurnitureFactory - 提供一系列相关或相互依赖的对象。
建造者模式BuilderHouseBuilder - 分步构建复杂的对象,如建造一个房子。
原型模式PrototypeShapePrototype - 通过复制现有对象创建新对象。
适配器模式AdapterSocketAdapter - 将一个类的接口转换为客户期望的另一个接口。
组合模式CompositeFileComposite - 以树形结构来表示整体与部分层次结构。
装饰模式DecoratorCoffeeDecorator - 动态地给一个对象添加额外的职责。
外观模式FacadeComputerFacade - 提供一个一致的界面,简化了客户端访问。
享元模式FlyweightCharacterFlyweight - 使用共享技术有效地支持大量细粒度的对象。
代理模式ProxyImageProxy - 为其他对象提供一个代理以控制对这个对象的访问。
责任链模式ChainSupportHandler - 使多个对象都有机会处理请求。
命令模式CommandLightCommand - 将请求封装成对象,使其可以参数化其他对象。
解释器模式InterpreterExpressionInterpreter - 定义一个解释器来解释语言中的句子。
迭代器模式IteratorArrayListIterator - 提供方法顺序访问一个元素。
中介者模式MediatorChatRoomMediator - 用一个中介对象来封装对象交互。
观察者模式ObserverWeatherObserver - 一对多的依赖关系,让多个观察者监听一个主题对象。
状态模式StateOrderState - 当一个对象的内在状态改变时允许改变其行为。
策略模式StrategySortingStrategy - 定义一系列算法,并将其封装起来,使其可以互相替换。
模板方法TemplateGameTemplate - 定义一个操作中的算法的骨架。
访问者模式VisitorNodeVisitor - 作用于某对象结构中的各元素的操作。

三、方法

工作中,使用过的一些通用性方法命名。

CodeCaseDescription
xxxInvoke() / InvokeXXX()beforeInvoke(xx)\afterInvoke()在激活调用某些方法,或者回调
xxxRun()/xxxStart()appRun()/xxxStart()特定功能开始、启动
xxxlaunch() / launchlaunch()动某个过程、服务或应用程序
doXXX()doDispatch真正的调用的方法,doGet(String BeanName)/ doRegister(XXX) 注册方法
executeXXX()executeCommand()执行模型方法
processXXX()processData()处理事情
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值