java软件开发的规范方案

...wd......wd......wd...软件开发标准命名标准系统中的命名一概不要出现首字母缩写的命名方式，如：/visit/hardware/info/findById不要写成/visit/hardware/info/fbi这种毫无可读性的方式又如：updateByPrimaryKeySelective(Entityentity);不要写成updateByPKS(Entityentity);以此类推……包命名规则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模块中请求地址命名：/工程名(子系统名称)/模块名/对象名(资源名)用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设备的信息假设数据库中有表base_system_log，建议定增删改查接口为查看：/工程名/base/systemlog/show?id=*修改：/工程名/base/systemlog/update删除：/工程名/base/systemlog/delete?id=*增加：/工程名/base/systemlog/add类文件命名：类别说明例如接口类所在接口类必须以大写字母“I〞开头,紧接着的字母也应大写IUser抽象类所有的抽象类都以“Abstract〞结尾ConnectionAbstract实现类所在实现类均以“Impl〞结尾UserServiceImpl泛型必须带“Generic〞，一般名字前加GenericBaseMapper控制类Spring控制类必须以“Controller〞结尾UserController服务层Spring服务层必须以“Service〞结尾UserService服务层实现类Spring服务层实现类必须以“ServiceImpl〞结尾UserServiceImpl数据库操作类所有以Mybatis框架操作数据库的类需以“Mapper〞结尾IHardwareMapperjava中类名、方法名、变量命名以字母大小写混写，不能挟带数字、下划线及其他字符final变量〔常量〕最好都大写数据库命名标准：表名必须以模块名称开头由于很多数据库都不区分大小写，所以表名及字段的命名都以小写和下划线“_〞混写，如：hard_hardware_group〔hard模块的硬件分组表〕第一个下划线前必须是模块名称主键都以“id〞命名，“group_id〞视图命名必须以“_view〞结尾“_vi〞函数命名必须以“_function〞结尾“_fn〞存储过程必须以“_procedure〞结尾“_proc〞注释标准类文件注释作用描述：必须创立者：建议，团队人多时可方便与其原作者沟通最后更新时间：可选方法注释方法使用描述：必须参数描述：必须返回说明：可选实体类注释属性说明：必须对应关系：建议方法体注释在方法内容中，只要在关键地方在注释就行了注释采用“//〞行注释，不建议使用“/*abc*/〞这种数据表注释1、各表字段在创立的时候必须有注释2、如果表中要引用其他表字段，而又没有外键时，一定在注释中标明关联的是哪个表的哪个字段编程准则所有工程必须都是UTF-8编码，缩进风格必须良好，不能以空格缩进，要以<TAB>键进展缩进，代码看起来要简单明了，一眼即可看出哪里开场，哪里完毕内部类尽量不要写，写的时候必须与设计人员讨论必要性实体类属性必须与表或视图字段相应，不能多或少，如果是偶尔要加的一个属性，请在mybatis直接返回MAP类型变量使用标准1、不允许随意定义全局变量。2、一个变量只能有一个用途；变量的用途必须和变量的名称保持一致。3、所有变量都必须在类和方法最前面定义，并分类排列。数据库操作标准1、查找数据库表或视图时，只能取出确实需要的那些字段。2、清楚明白地使用列名，而不能使用列的序号。注：不能使用Select*fromtable方式。3、数据库字段一般开发人员不要增加，就与模块负责人或系统设计人员讨论是否该加，并及时通知工程中所有人员。4、数据库中均要以模块名称开头，具体命名参照第1章第4节数据库命名标准5、组合查询，关联表查询一般要求创立视图来实现，不建议在查询语句中嵌套查询，具体请与系统设计人员讨论对象使用标准1、尽可能晚地创立对象，并且尽可能早地释放它。模块设计原则1、公用的方法和类必须放在指定类中。 模块工具类放模块util包，系统工具类放core.util包，各系统都会用的，放base.util包 模块公共类放在模块common包，系统公用类放在coremon包，各系统都会用的，放在basemon包2、方法功能单一，不允许一个方法实现两个及两个以上的功能。3、方法与方法之间只允许存在包含关系，而不允许存在穿插关系。即两者之间只存在单方向的调用与被调用，不存在双向的调用与被调用。4、系统分为三层构造，分别为业务控制层、服务层、数据层，每层各司其职，不能混