分享一个常用的命名规则和Spring的命名风格

目录

Spring 命名风格规范总结表

常用代码命名单词（通用且专业）

 命名技巧

一、返回布尔值的方法

二、条件执行方法

三、异步处理方法

四、回调方法

五、集合操作方法

六、状态校验方法

七、对象生命周期方法

八、数据操作方法

---

Spring 命名风格规范总结表

类别	命名规则	示例	错误示例
包名	全小写，按模块划分，使用 . 分隔	com.example.demo.service	com.Example.Service
类名	PascalCase（大驼峰），根据功能添加后缀	UserService、OrderController	userService、Order_Controller
接口名	PascalCase，通常不加 I 前缀	UserService、UserRepository	IUserService
方法名	camelCase（小驼峰），动词开头，语义清晰	getUserById()、deleteOrder()	FetchUserData()、UserfindById()
变量 & 参数名	camelCase，布尔值用 is 或 has 开头	userName、isActive	User_Name、active
Bean 名称	默认类名首字母小写，可用 @Bean 指定	@Service("userService")	@Service("UserServiceImpl")
实体类（Entity）	PascalCase，直接使用业务名称	User, Order	User_Entity
DTO（数据传输对象）	业务名 + DTO	UserDTO	User_Data_Transfer
VO（视图对象）	业务名 + VO	UserVO	UserViewObj
Service 层	业务名 + Service	OrderService	OrderServices
Controller 层	业务名 + Controller	UserController	UsersCtrl
Repository 层	业务名 + Repository 或 Dao	UserRepository	UserRepo
配置类	业务名 + Config	SecurityConfig	SecConfig
拦截器	业务名 + Interceptor	AuthInterceptor	AuthFilter
监听器	业务名 + Listener	UserEventListener	UserListner
工具类	业务名 + Util 或 Utils	DateUtil, JsonUtils	DateUtilityClass
切面（AOP）	业务名 + Aspect	LoggingAspect	LoggerAop
REST API URL	资源名用复数，遵循 RESTful 规范	/users/{id}、/orders	/getUserById、/deleteUser
Spring Data JPA 方法	findByXxx()、deleteByXxx()、countByXxx()	findByEmail()、deleteById()	searchUserByEmail()

常用代码命名单词（通用且专业）

适用于 Java 开发，包括 Spring、工具类、设计模式等

单词	含义	常见用途	示例
Abstract	抽象	抽象类或方法	AbstractUserService, AbstractFactory
Adapter	适配器	适配不同接口的类	JsonAdapter, DatabaseAdapter
Aggregator	聚合器	聚合多个数据源	LogAggregator, MetricsAggregator
Analyzer	分析器	数据分析工具	TextAnalyzer, ImageAnalyzer
Builder	构造器	生成复杂对象	UserBuilder, QueryBuilder
Cache	缓存	临时存储数据	UserCache, SessionCache
Collector	采集器	收集数据或日志	MetricsCollector, LogCollector
Component	组件	可复用的模块	RedisComponent, EmailComponent
Config / Configuration	配置	配置类	SecurityConfig, AppConfiguration
Connector	连接器	连接外部系统	DatabaseConnector, ApiConnector
Constants	常量	全局静态常量	AppConstants, HttpConstants
Context	上下文	共享状态或环境信息	ApplicationContext, ExecutionContext
Controller	控制器	处理请求	UserController, ProductController
Converter	转换器	类型转换	DateConverter, JsonConverter
Dispatcher	调度器	分发任务或请求	EventDispatcher, TaskDispatcher
Engine	引擎	运行核心逻辑	SearchEngine, RuleEngine
Executor	执行器	执行任务	TaskExecutor, CommandExecutor
Factory	工厂	创建对象的类	BeanFactory, ConnectionFactory
Filter	过滤器	过滤数据	RequestFilter, LogFilter
Generator	生成器	生成唯一 ID、代码等	IdGenerator, TokenGenerator
Handler	处理器	处理事件、异常等	RequestHandler, ErrorHandler
Helper	助手	提供辅助方法	JsonHelper, HttpHelper
Initializer	初始化器	进行系统或组件初始化	AppInitializer, DatabaseInitializer
Interceptor	拦截器	拦截请求或数据流	AuthInterceptor, LoggingInterceptor
Job	任务	定时任务或后台任务	BackupJob, EmailJob
Loader	加载器	加载资源	ConfigLoader, DataLoader
Manager	管理器	负责某个资源的管理	UserManager, CacheManager
Mapper	映射器	处理对象转换	UserMapper, DtoMapper
Mediator	中介者	协调多个对象交互	EventMediator, ChatMediator
Monitor	监控器	监视系统状态	ServiceMonitor, HealthMonitor
Observer	观察者	监听事件	EventObserver, StateObserver
Parser	解析器	解析文本、数据	JsonParser, XmlParser
Pipeline	管道	处理数据流	ImageProcessingPipeline, DataPipeline
Processor	处理器	处理数据或任务	OrderProcessor, PaymentProcessor
Provider	提供者	提供特定服务	AuthProvider, PaymentProvider
Proxy	代理	控制访问对象	HttpProxy, DatabaseProxy
Registry	注册表	维护映射关系	ServiceRegistry, BeanRegistry
Renderer	渲染器	生成 UI 或图像	HtmlRenderer, ChartRenderer
Resolver	解析器	处理依赖解析	PathResolver, DependencyResolver
Scheduler	调度器	处理定时任务	JobScheduler, TaskScheduler
Service	服务	业务逻辑层	UserService, OrderService
Session	会话	管理用户会话	UserSession, SessionManager
Singleton	单例	设计模式中的单例类	LoggerSingleton, AppSingleton
Strategy	策略	处理不同策略	CompressionStrategy, SortingStrategy
Task	任务	执行具体任务	DataSyncTask, EmailTask
Tracker	追踪器	记录行为	EventTracker, UserTracker
Transformer	转换器	数据转换	DataTransformer, XmlToJsonTransformer
Utils / Util	工具类	提供通用方法	DateUtils, StringUtil
Validator	校验器	处理数据验证	InputValidator, PasswordValidator
Wrapper	包装器	对象封装	ResponseWrapper, DataWrapper

 命名技巧

1. 遵循 "对象 + 作用" 模式：

   • UserManager（管理用户）

   •  OrderProcessor（处理订单）

   •  ManageUsers（动词开头不符合命名习惯）

2. 避免冗余：

   •  DateUtils（日期工具类）

   • DateUtilityClass（UtilityClass 冗余）

3. 遵循行业术语：

   • TaskScheduler（定时任务调度）

   •  JwtProvider（JWT 令牌提供者）

   •  TokenThing（语义不明确）

一、返回布尔值的方法

位置	前缀	意义描述	示例
前缀	is	对象是否处于预期状态	isChecked
前缀	can	对象能否执行预期行为	canRemove
前缀	should	执行某指令是否明智	shouldMigrate
前缀	has	对象是否具有预期数据属性	hasObservers
前缀	needs	调用者是否需要执行某指令	needsMigrate

二、条件执行方法

位置	词缀	意义描述	示例
后缀	IfNeeded	必要时执行，否则无操作	drawIfNeeded
前缀	might	同上	mightCreate
前缀	try	尝试执行，失败抛出异常/错误码	tryCreate
后缀	OrDefault	失败返回默认值	getOrDefault
后缀	OrElse	失败返回参数指定值	getOrElse
前缀	force	强制执行，错误通过异常/返回值表示	forceCreate

三、异步处理方法

类型	词缀	意义描述	示例
前缀	blocking	阻塞线程执行	blockingGetUser
后缀	InBackground	后台线程执行	doInBackground
后缀	Async	异步方法	sendAsync
后缀	Sync	同步方法（有对应异步版本）	sendSync
前缀/词干	schedule	调度队列任务	scheduleJob
前缀/词干	post	提交任务	postJob
前缀/词干	execute	执行异步处理	executeTask
前缀/词干	start	启动异步处理	startJob
前缀/词干	cancel	取消异步处理	cancelJob
前缀/词干	stop	停止异步处理	stopJob

四、回调方法

前缀	触发时机	示例
on	事件发生时触发	onCompleted
before	事件发生前触发	beforeUpdate
pre	同 before	preUpdate
will	同 before	willUpdate
after	事件发生后触发	afterUpdate
post	同 after	postUpdate
did	同 after	didUpdate
should	检查事件是否允许发生	shouldUpdate

五、集合操作方法

方法	功能描述	示例
contains	是否包含指定元素	contains
add	添加元素	addJob
append	尾部追加元素	appendJob
insert	在指定位置插入元素	insertJob
put	添加键值对元素	putJob
remove	删除元素	removeJob
enqueue	队列尾部添加元素	enqueueJob
dequeue	移除并返回队列头部元素	dequeueJob
push	压入栈顶	pushJob
pop	弹出栈顶元素	popJob
peek	查看栈顶元素（不移除）	peekJob
find	查找符合条件元素	findById

六、状态校验方法

方法	功能描述	示例
ensure	检查满足状态，否则抛出异常/错误码	ensureCapacity
validate	校验状态合法性，非法时抛出异常/错误码	validateInputs

七、对象生命周期方法

方法	功能描述	示例
initialize	初始化对象	initialize
abandon	主动释放资源	abandon
destroy	销毁对象	destroy
dispose	释放对象资源	dispose

八、数据操作方法

方法	功能描述	示例
create	创建新对象	createAccount
new	创建新实例	newAccount
from	根据已有数据构造新对象	fromConfig
to	数据转换	toString
update	更新已有数据	updateAccount
load	加载数据（本地）	loadAccount
fetch	获取数据（远程）	fetchAccount
delete	删除数据	deleteAccount
remove	移除数据	removeAccount
save	持久化保存	saveAccount
store	存储数据	storeAccount
commit	提交变更	commitChange
apply	应用变更	applyChange
clear	清空数据/恢复初始状态	clearAll
reset	重置数据/恢复初始状态	resetAll