java方法的一些设计注意点

来源:互联网 发布:自动驾驶分级 知乎 编辑:程序博客网 时间:2024/05/18 14:14

  对于java的方法的名称和参数的一些设计需要注意的地方

  1.方法的名称:方法的名称应该遵循易懂性和统一性原则

     易懂性:方法的名称能够一目了然,看你取的方法名便能够明白个方法的是要干什么,在这里需要注意,如果一个方法的职责很多造成名称很长,这时候我们要考虑重构这份方法,让方法的职责能够简单。方法的命名一般遵循todo,即干+什么,前面动词后面名词。方法的名称最好不要用拼音,尤其是不能用拼音的简写,这样在后面的维护工作中,将是一个非常难懂的,记得曾经做过的一个小项目中,就用到拼音(数据库表),结果,现在在回过头去看,一下子都不知道这些表是什么表,虽然是数据库表,但是对于程序更应该注意。

    统一性:软件开发是一个群体性的活动,所以,对于方法的名词,应该有一个统一的规范,这个跟类,包等等一系列的相关的命名一样,都要有一个约定俗成的统一规范,这样在这个团队中的其他人能够看你的方法名,就能够明白这个方法是干什么的。

  2.方法的参数:方法的参数最好不要超过4个,多了就容易犯错,尤其是当参数的类型是一样的时候,这个时候更容易犯隐性的错误。

   当方法参数过多的时候,可以考虑下面三种方法来减少减少参数:

   方法一:将这个方法拆分成多个方法,这样也可以减少一个方法的职责,当然如果拆分后发现,拆分出了很多的方法,这个时候,可以考虑通过方法的正交性来减少一些方法。

   方法二:构建辅助类,通过将这些参数作为辅助类的域来实现减少方法的参数。这些辅助类一般都是静态成员类。

   方法三:通过builder模式来减少参数,builder模式比较针对的是参数是可以选择(即某些参数并不是必要的,如在构造一个对象的时候,有些的属性并不一定需要),通过builder的setter方法,实现参数的设置。

  3.方法的参数尽量的要面向接口,而不是面向具体的实现,这么做其实是比较有助于扩展,传入的参数是接口,我们在后续的修改中可以传入其他的实现了接口的实现类,这个方法在一定程度上就可以扩展了。

原创粉丝点击