Java: 命名的讲究

    技术2022-05-12  0

    这样的文章很多,但这里是对我观察到的和我个人经验的总结。

     

    1、类名类名通常以名词结尾。而且在类名中要体现它是以保存数据为主还是提供功能为主。例如 ConnectionBuilder 这个类我们都可以猜到它的主要功能是创建 Connection 对象,以动词-er/or 结尾的类名,至少应该包含一个以该动词开头的方法。例如 ConnectionBuilder 这个类,它至少应该包含一个以 build- 开头的方法。有了这种默契,别人就能更方便的使用这个类。2、增删改查方法的命名以对 Person 类的增删改查为例——

    创建一个 Person对象的方法一般命名为 createPerson()/newPerson(),添加方法命名为 addPerson(),修改方法命名为 updatePerson(),删除方法命名为 deletePerson()/removePerson(),根据主键查询的方法命名为 getPerson()/queryPerson()。根据其他条件来查询,要指出具体的条件类型,例如 getPersonByName() 或 getPersonByAge()。

    方法的名称要统一。例如一开始用的是 deleteXXX 而不是 removeXXX,那么整个项目都应该这样用下去。3、计数方法计数方法通常命名为 getNumberOfXXX()/getXXXCount()。例如 getNumberOfRows(),getQuestionCount()。4、返回 boolean 值的方法在 JavaBean 中,返回 boolean 属性必须用 isXXX() 命名。检查某个属性是否为空或者某条记录是否存在的方法,通常命名为 hasXXX(),例如 hasResult()。检查对象状态的方法通常以 is+形容词 命名。例如 isClosed(),isReady()5、返回集合对象的方法返回集合对象的方法应该体现出复数形式,例如 getPersons(),也可以体现容器类型,例如 getPersonList()。6、不要简化单词不要写 getHisList(),而要写 getHistoryList();不要写 usrno,而要写 userNumber。一个简单的原则是要能够把这个名字读出来。7、参数命名应该精确createUser(String str1, String str2) 看起来很难懂,但要是写成 createUser(String userName, String password) 就很好懂了。8、返回值命名为 result在一个方法中将返回值命名为 result,能够让方法的脉络更清晰。

     

    -------------- 补充 --------------

    9、接口

    接口命名没有什么专门的原则,和类名一样要能够准确体现接口的功能。

     

    有人喜欢在接口名字前面加 I。完全可以。不管加不加,都要保证整个项目的统一性。

     


    最新回复(0)