java编写webapi接口
在用Java进行开发前,一定要牢牢遵守Java的开发规范,唯有如此你的Java开发之路才能更为顺畅。而掌握相应的Java开发技巧,则可以让你工作起来事半功倍。那在编写代码时有什么开发规范和技巧呢?
1、代码编写规范:
代码编写遵守Java通用开发规范和必联代码开发规范
每个类及方法都要有合理的注释,并且对注释要持续维护
根据接口需求编写单元测试用例,再编写实现类使得单元测试通过,如此循环往复以使得所有的单元测试通过
要求每个Java方法的代码行数不能超过100行
代码编写按照功能划分,一个接口分为多个方法,每一个方法做什么事情,做到思路清晰。
接口设计尽量做到多兼容性,方便后期开发
2、数据库设计及SQL规范
不使用MySQL数据库外键约束,通过应用程序逻辑实现关联约束
适当建立索引,经常作为查询条件的字段、唯一性程度高、长度不是很长的、数量不宜太多,一般一个表的索引数目在5个以内
表名长度不能超过30个字符,表名最好选择一个单词,能够准确清晰明了地表示实体含义,若必须多个单词则以下划线“_”分隔,单词所有字母均小写
表名不要使用汉语拼音表示,不需要带前缀
数据库字段名全部采用小写英文单词,单词之间用”_”隔开。字段长度不能超过30个字符
如果该字段是主键,则在单词后加_id,在设计表时如果该字段是该数据的唯一属性可以使用_id表示该字段名,方便以后的多期项目
如果该字段表示的是时间,则使用_time为后缀
数据库表设计尽量做到兼容性,方便后期开发
在软件工程领域,源程序的风格统一标志着可维护性、可读性,是软件项目的一个重要组成部分。
通过建立代码编写规范,形成开发小组编码约定,提高程序的可靠性、可读性、可修改性、可维护性、可继承性和一致性,可以保证程序代码的质量,继承软件开发成果,充分利用资源,使开发人员之间的工作成果可以共享。
Java实现接口(打印机)
打印机实现接口需求说明以及实现效果实现方式:从需求中提炼出所有的名词:彩色,黑色,墨盒;A4,B5,纸张;打印机其中墨盒可以有一种标准,所以可以将墨盒设置为接口,让彩色和黑色墨盒使用这个接口纸张也可以有一个标准,所以可以将纸张设置为接口,让A4和B5都使用这个接口代码如下纸张接口:
publicinterfacepapper{//纸张大小Stringsize();}磨合接口:
publicinterfaceinkBox{//墨盒实现的颜色Stringcolor();}实现纸张大小A4
publicclassA4papperimplementspapper{publicStringsize(){//TODOAuto-generatedmethodstubreturn"a4纸张";}}实现纸张大小B5
publicclassB5papperimplementspapper{publicStringsize(){//TODOAuto-generatedmethodstubreturn"B5纸张";}}实现墨盒接口(黑色)
publicclassblackInkimplementsinkBox{publicStringcolor(){return"黑色墨盒";}}实现墨盒接口(彩色)
publicclasscolorInkimplementsinkBox{publicStringcolor(){//TODOAuto-generatedmethodstubreturn"彩色墨盒";}}打印机类
publicclassprinter{//实例化接口papperpapper;inkBoxinkBox;//无参构造方法publicprinter(){}//有参构造方法publicprinter(papperpapper,inkBoxinkBox){this.papper=papper;this.inkBox=inkBox;}//打印输出方法publicStringprint(){return"使用"+inkBox.color()+"在"+papper.size()+"上打印";}}测试类Test
publicclassTest{publicstaticvoidmain(String[]args){printerprinter=newprinter(newA4papper(),newcolorInk());System.out.println(printer.print());//使用彩色墨盒在a4纸张上打印printerpr=newprinter(newB5papper(),newblackInk());System.out.println(pr.print());//使用黑色墨盒在B5纸张上打印}}谢谢观看,希望可以帮助到你们