java命名规范

- config 配置信息, 从配置文件读取进来的, 都在这里转化成 Java Object
  - common 公共定义信息, 包括 exception, responsecode, util 等
  - dao 数据库访问层
  - manager 通用业务处理层    
    - 对第三方平台封装的层,预处理返回结果及转化异常信息
    - 对 service 层通用能力的下沉,如缓存方案、中间件通用处理
    - 与 DAO 层交互,对多个 DAO 的组合复用
  - service 层,相对具体的业务逻辑服务层,由 interface+implement 组成
    - interface 接口层,所有需要对外提供的接口,都定义在 interface 里(web 层直接访问 interface)
    - implement 接口实现层,一个完整的事务由这里进入,即 @Transactional 都在这里定义 
      - 一般来说,如果可以一个函数写完的,就在 implement 里写完;如果需要拆分成 2 个以上的函数,建议需要写到 manager 层里
      - 对于一些简单 sql 查询,implement 层可以直接访问 DAO 层
  - web 页面访问入口, Restful url 声明都在这里
  - task 定时任务, 相关启动 cron 配置, 都应该写在 application-task.properties 里
  
- 启动函数
  - WebApplication 在 web module里, 感觉应该放在 config 里比较合适; 但是 run 一个 config 也怪怪的
  
- 服务说明
  - 如果以后需要往外提供接口服务, 需要注意只能导出 interface\common 这两层; 所以这两层, 应该要能完备描述这个系统的功能

 

========================================================

- 分层领域模型规约(By 阿里巴巴 Java 开发手册)
 - DO(Data Object):与数据库表结构一一对应,通过 DAO 层向上传输数据源对象。
 - DTO(Data Transfer Object):数据传输对象,Service 和 Manager 向外传输的对象。
 - BO(Business Object):业务对象。可以由 Service 层输出的封装业务逻辑的对象。
 - QUERY:数据查询对象,各层接收上层的查询请求。注:超过 2 个参数的查询封装,禁止使用 Map 类来传输。
 - VO(View Object):显示层对象,通常是 Web 向模板渲染引擎层传输的对象。
  
- GAV 规约(与阿里巴巴 Java 开发手册不同)
 - 考虑到我们是多 module 以及 .m2 下面 repository 目录层次结构,以及新建项目时文本替换的便利性
 - GroupID 按 4 层,如 com.eking.sample.base (sample 为具体的业务,base 为业务微服务),com.eking.newgt.baseinfo
 - ArtifactID 按 业务线-微服务-module名,如 newgt-order-common、newgt-order-config;newgt-baseinfo-common、newgt-baseinfo-task

 

 

 

- 统一命名规范
- SpringBoot run 起来
- 前台参数传到后台 GET、POST;RequestParam、RequestBody
- 数据库增删改查(JDBC、JPA、Hibernate、MyBatis)
  - jpa 增删改查
  - 原生 sql 执行
  - 事务(写两个表,一个成功、一个不成功)
  - 分页(后续)
- log 配置
- 配置文件读取、分离
- 分层
- 分 module
- 异常整体定义、全局捕获
- 定时任务
- 缓存(Memcached、Redis)
- httpInvoker 支持
- rpc 接口支持(dubbo)
- RESTful 接口文档化(swagger)
- 安全控制(JWT、SpringSecurity、Shiro)
- SpringCloud 整体框架
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
1. 模块命名、数据库表命名、域模型命名、各分层的类/方法命名、页面的命名; 模块命名: a. 包命名:com.project_name.module_name.action/service/dao/ws; service的实现都置于com.project_name.module_name.service.impl下; b. 接口命名遵守XxxxService,接口实现遵守XxxxServiceImpl; 2. 包的设计、页面的层次结构设计(jsp/css/js等文件的结构); 3. log、异常(声明式异常)的约定设计; 4. 链接、按钮、表单提交的统一方式;通用式Ajax调用与页面跳转统一模型; 5. 响应一个请求的分层结构约定,列举几个示例(常规调用、Ajax调用、WebService调用、提供WebService暴露、硬件设备接口调用); 6. 验证代码质量的约定,如JUnit、EMMA、FindBugs、CheckStyle、PMD的使用;Hudson持续集成需注意的; 7. 压力测试、防内存泄漏测试; 基础CSS:标签的各种状态的样式;表格单双行的样式; 开发一个Action请求的响应: 前置条件:该Action涉及的Entity及EntityName.hbm.xml已经准备好。 步骤: a. 前端页面触发Action的请求; 统一采用全路径请求,URL格式: 1> basePath/web/moduleName/*_ *.action {1}  EntityName,{2}  ActionMethodName 2> basePath/web/moduleName/gotoXxx.action (无需调用Service,直接跳转) 包括jQuery的Ajax方式和非Ajax方式; 包括表单提交; 参数设值的方式: 1> URL参数: basePath/web/moduleName/*_*.action?entity.propertyName=paramValue&paramName=paramValue 2> 或 另外,对于表单的提交,前后台都必须做数据校验,SWDF已提供了此能力,进行简单的配置即可,前台直接提供类似以下代码即可,点此查看前端校验详细规则说明。 前端校验示例; 后台数据校验,点此查看校验详细说明. b. 配置struts-moduleName.xml; 直接跳转示例; 调用Service示例; c. 开发对应的{EntityName}Action类; 该类必须继承com.hikvision.swdf.xx.BaseAction,该Action类有一个关键属性entity,即泛型Entity类的一个实体,该属性默认填充好了请求提交过来的entity对应参数(即entity.propertyName); d. 开发Service接口和Service接口实现,并在Action中通过set方法注入该Service; 接口文件:UserService 接口实现:UserServiceImpl 注入Service e. 开发DAO,DAO继承com.hikvision.xxx.HibernateBaseDAO; 示例 f. 配置applicationContext-*.xml; 配置DAO bean、Service Bean、Action Bean及注入的配置; g. 测试; 备注: 1. Action建议统一遵守通配符的约定,basePath/web/moduleName/*_ *.action {1}  EntityName,{2}  ActionMethodName 2. 统一命名规则:接口类似UserService,接口实现类型UserServiceImpl;(IUserService和UserServiceImpl) 开发一个Action调用关联应用提供的WebService 前置条件:该WebService?WSDL可正常获取 步骤: a. 配置applicationContext-wsclient.xml; Spring管理第三方WebService实例bean Jaxws-client配置代码 b. 生成第三方WebService接口文件;(提供系统自动生成) 自动生成代码 c. 页面调用Action请求,Action中注入WebService实例bean; Action对应方法直接调用第三方WebService的相关方法; d. 测试; 备注: 1. 步骤b,接口文件必须同包名同类名置于src目录下; 开发一个Action调用关联应用开放的HTTP请求 步骤: 1. 页面调用Action请求; 2. Action类相应方法使用封装好的HttpClient相关工具类,准备好HTTP请求的相关参数header参数和body参数并以xml的方式提交HTTP请求; 3. 解析该HTTP请求返回值(XML或JSON); 4. 响应结果; 5. 测试; 备注: 开发一个需要对第三方应用发布的WebService 步骤: a. 开发WebService接口,@WebService进行注解该接口; b. 开发WebService接口实现类,@WebService注解该实现类,并制定endpointInterface; c. 配置applicationContext-ws.xml d. 测试 备注: 开发一个需要对第三方应用发布的RESTful Service 步骤: a. 开发RS接口,提供如下Annotation; b. 开发RS接口实现,并提供如下Annotation; c. 配置applicationContext-rs.xml 备注: 所有Annotation的涵义解释如下:
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值