Maven项目包命名规范：先学习再超越

作者：Odboy (opens new window)

本站地址：https://blog.odboy.cn (opens new window)

参考结构

• api 查询接口和实现类
  • 类型名称, 比如权限permission, 里面包含permission和role
    • dto 查询参数
    • impl 查询接口实现
• constant 常量和枚举类
• controller 对外控制器
• convert Mapstruct等类型转换器
• dal
  • dataobject 数据库实体类
  • mysql mysql数据库对应的mapper实体类
• framework 脚手架、基础设施等
  • captcha 验证码
  • datapermission 数据权限
  • operatelog 操作日志
  • sms 短信发送
• job 定时任务
• mq 消息队列
  • config 配置
  • consumer 消费者
  • producer 生产者
• repository 对接三方服务，比如gitlab、jenkins、k8s等
• service 业务接口
  • dto 业务参数
  • impl 业务实现
• util

Demo

• api
  • permission
    • RoleApi
    • PermissionApi
    • dto
      • QueryRoleByArgs
      • QueryPermissionByArgs
    • impl
      • RoleApiImpl
      • PermissionApiImpl
• constant
  • MenuTypeEnum
  • DataScopeEnum
  • SystemConst
• controller
  • AuthController
  • CaptchaController
• convert
  • AuthConvert
• dal
  • dataobject
    • UserDO
    • RoleDO
  • mysql
    • UserMapper
    • RoleMapper
• framework
  • captcha
    • config
      • CaptchaConfiguration
    • core
      • CaptchaService 这里为什么是service,因为验证码是该系统所属的
• job
  • SyncUserJob
• mq
  • config
    • RocketMQConfiguration
  • consumer
    • AliPayInfoRocketMQConsumer
  • producer
    • AliPayInfoRocketMQProducer
• repository
  • gitlab
    • GitlabAuthRepository
    • GitlabUserRepository
    • GitlabProjectRepository
    • GitlabPipelineRepository
  • jenkins
    • JenkinsAuthRepository
    • JenkinsPipelineRepository
  • k8s
    • KubernetesAuthRepository
    • KubernetesNamespaceRepository
    • KubernetesServiceRepository
    • KubernetesStatefulSetRepository
• service
  • MenuService
  • RoleService
  • impl
    • MenuServiceImpl
    • RoleServiceImpl
• util