java软件开发规范-V0.1VIP专享VIP免费

下载后可任意编辑软件开发法律规范第1章 命名法律规范系统中的命名一概不要出现首字母缩写的命名方式，如：/visit/hardware/info/findById 不要写成 /visit/hardware/info/fbi 这种毫无可读性的方式又如：updateByPrimaryKeySelective(Entity entity);不要写成updateByPKS(Entity entity);以此类推……1.1.包命名规则com/公司名（dashu）/子系统名称（项目名）/模块名/各系统必备模块描述：base:系统基础模块，各系统都共用的模块，提供系统最基本的运行环境，如日志操作管理，系统配置管理，公共工具类，公共字典管理core:各子系统的核心模块，协调该系统中各模块之间相应的调用其他模块根据系统再进行具体划分各模块下各包的命名包名称说明entity物理实体，与物理表相对应vo视图类实体web(controller/action/servlet)控制层，需要返回页面才用，返回 json 数据的用其他包webservicewebservice开放接口，返回 json 数据的控制层，可根据实现的框架去命名子层包名，如：rest/axit2/cxf/jmxservicespring 服务层，子层包名 implrepository(mapper/dao)数据操作层util该模块的一些工具类存放包api内部调用接口包，由于各模块功能要求相应独立，所以不建议直接注入其它模块的 service 类，最好统一在此提供本模块的所有 service 类common存放公共类下载后可任意编辑interceptor本系统中所有的拦截器存放包，该包只在 core 模块中listen本系统中所有的监听器存放包，该包只在 core 模块中filter本系统中所有的过滤器存放包，该包只在 core 模块中1.2.请求地址命名：/项目名(子系统名称)/模块名/对象名(资源名)用 spring4 中 @RestController 注解实现 restful 风格的设计。 如：请求方式地址说明GET/visit/hard/hardwareinfo?type=auth猎取硬件终端设备列表GET/visit/hard/hardwareinfo/{id}猎取某个 id 设备的信息POST/visit/hard/hardwareinfo增加一个设备信息POST/visit/hard/hardwareinfo/{id}更新某个 id 设备的信息DELETE/visit/hard/hardwareinfo删除多个附合条件的设备信息DELETE/visit/hard/hardwareinfo/{id}删除某个 id 设备的信息假如数据库中有表 base_system_log，从而直接清楚地知道该表的增删改查的接口是/项目名/base/systemlog/{id}采纳原始命名：请求方式地址说明/visit/hardware/hardwareinfo/search?type=auth猎取硬件终端设备列表/visit/hareware/hardwareinfo/findById?id=1猎取某个 id ...