Java高级规范之三

  

三十一、如果变量名要加注释,说明命名不是很准确。

不规范示例:暂无

规范实例:暂无

解析:暂无

三十二、任何类字段除非必要,否则都要私有化

不规范示例:

public class Person{

  String name;

  String sex;

  int age;

}

规范示例:

public class ClassName{

  private String name;

  private String sex;

  private int age;

}

解析:没有为程序的安全考虑,可以被其他的类访问

三十三、尽量减少一个类属性的作用域,在离使用它的最近的地方定义。

不规范示例:

  int index = 1;//类似这种情况,变量声明离使用的地方有些远。

  String sql = "insert into
Student(ID,name,password,sex,address)Values(?,?,?,?,?)"

  PreparedStatement preparedStatement= connection.prepareStatement(sql);

  preparedStatement.setString(index++,user.getID());

  preparedStatement.setString(index++,user.getName());

  preparedStatement.setString(index++,user.getPassword());

  preparedStatement.setString(index++,user.getSex());

  preparedStatement.setString(index++,user.getAddress());

  preparedStatement.executeUpdate(); preparedStatement.close();

规范示例:

  String sql=  "insert into
Student(ID,name,password,sex,address)Values(?,?,?,?,?)"

  PreparedStatement preparedStatement= connection.prepareStatement(sql);

  int index = 1;

  connection.prepareStatement(sql);

  preparedStatement.setString(index++,user.getID());

  preparedStatement.setString(index++,user.getName());

  preparedStatement.setString(index++,user.getPassword());

  preparedStatement.setString(index++,user.getSex());

  preparedStatement.setString(index++,user.getAddress());

  preparedStatement.executeUpdate(); preparedStatement.close();

解析:当别人维护时容易引起混淆,容易引发错误。

三十四、单例模式的使用必须要考虑同步。

不规范示例:

  public static  Connection conn=null;

  //没有使用同步

  public static Connection getConnection()throws
ClassNotFoundException,SQLException{

    if(){

      if(conn==null){

      Class.forName("com.p6spy.engine.spy.P6SpyDriver");

      conn=DriverManager.getConnection("jdbc:mysql://locallhost:3306/test",
"root","root");

      }

    return conn;

  }

规范示例:

//最熟悉地得到一个Connection连接

  public static  Connection conn=null;

  public static synchronized Connection getConnection()throws
ClassNotFoundException,SQLException{

    if(){ if(conn==null){

    Class.forName("com.p6spy.engine.spy.P6SpyDriver");

    conn=DriverManager.getConnection("jdbc:mysql://locallhost:3306/test",
"root","root");

    }

    return conn;

  }

解析:当有多个用户并发使用的时候会造成数据的混乱,导致线程不安全

三十五、方法里面参数最好不要超过三个。

不规范示例:

  public void update(int id,String name,String code,String sex){

    ........................

  }

规范示例:

  public void update(int id,String,name,String sex){

    ........................

  }

  //如果参数超过三个,必须把数据封装成一个pojo

  //如把上面的update方法中的参数封装起来

  public class User(){

    private int id;

    private String code;

    private String name;

    public String getName(){return name;}

    public void setName(String name){this.name=name;}

    public void String getCode(){return code;}

    public void setCode(String code){this.code=code;}

    public void setId(int id){this.id=id;}

    public void getId{return id;

  }

    ......................

  public void update(User user){

    ..................

  }

解析:参数多容易出现错误,尤其是调用的时候,如果参数的顺序传错误,将是一个非常大的麻烦,而且没有拓展性

三十六、值类或值对象必须重写toString方法。

不规范示例:

  public calss Code{

  private int id;

  private String code;

  private String name;

  private String sex;

  public String getSex(){return sex;}

  public void setSex(String sex){this.sex=sex;}

  public String getName(){return name;}

  public void setName(String name){this.name=name;}

  public void String getCode(){return code;}

  public void setCode(String code){this.code=code;}

  public void getId{return id;}

  public void setId(int id){this.id=id;}

  }

规范示例:

  public calss Person{

  private int id;

  private String code;

  private String name;

  private String sex;

  public String getSex(){return sex;}

  public void setSex(String sex){this.sex=sex;}

  public String getName(){return name;}

  public void setName(String name){this.name=name;}

  public void String getCode(){return code;}

  public void setCode(String code){this.code=code;}

  public void getId{return id;}

  public void setId(int id){this.id=id;}

  public String toString(){

    return new
StringBuffer().append(id+",").append(name+",").append(sex).toString();

  }

  }

解析:toString的作用是以字符串的形式返回它的实例信息,因为不同的类的信息是不同的,所以要重写,不能全部都继承Object的toString方法。

三十七、重写equals方法的时候,必须重写hashCode方法。

不规范示例:

  public class People{

  //必要的属性

  //必要的get和set方法

  //toString方法

  没有hashCode方法

  没有equals方法

  }

规范示例:

  public class People{

  //必要的属性

  //必要的get和set方法

  //toString方法

  public int hashCode(){

  final int prime = 37;

  int result =1;

  result = prime * result +id;

  result = prime * result +((name==null)?0:name.hashCode());

  result = prime * result +((sex==null)?0:sex.hashCode());

  return result;

  }

  public boolean equals(Object obj){

  if(this==obj) return true;

  if(obj==null) return false;

  if(getClass()!=obj.getClass()) return false;

  People other = (People)obj;

  if(id!=other.id) return false;

  if(name==null){

  if(other.name!=null) return false;

  } else if(!name.equals(other.name)) return false;

  if(sex==null){

  if(other.sex!=null) return false;

  }else if(!sex.equals(other.sex)) return false;

  return true;

  }

  }

解析:重写equals和hashcode方法是为了像Set一样不能存储重复的元素,并实现Serializable是为了使这个类可以序列化

三十八、单元测试的时候必须是对象比较,如果一个字段有100个字,有时候数据库会自动删除一些,此时我们就不知道程序哪儿出bug了。

不规范示例:暂无

规范示例:暂无

解析:实用的开放经验

三十九、单元测试类的类名后面要加Test。

不规范示例:

  //这是一个UserDAO的单元测试类

  public class UserDAO{}

规范示例:

  public class UserDAOTest{}

解析:这样写是让别人知道这个类是用做测试的,清晰易懂。

四十、操作提示颜色,成功用蓝色字体,错误用红色字体。

不规范示例:暂无

规范示例:暂无

解析:实用的开放经验

Java高级规范之三,布布扣,bubuko.com

时间: 2024-10-14 19:38:42

Java高级规范之三的相关文章

Java高级规范之四

四十一.控制层不能调用model层除了最顶级的接口外的任何内容.要通过new顶级接口才能调用. 不规范示例: public class UserServiceImpl{ private UserDAOImpl userDAOImpl; private UserServiceImpl(){ userDAOImpl = new UserDAOImpl(); } public void deleteById(Long id){ userDAOImpl.deleteById(id); } } 规范示例:

java高级规范

一:不允许使用汉语拼音命名(类,接口,包,常量,全局变量,局部变量,临时变量,方法名) 欠规范代码示例: public void zengJiaYongHu(){} 拼音方法名称 规范代码示例: public void addUser(){} 解析:应当使用国际化语言,拼音使得代码难懂 二:Package名必须全部小写,尽量使用单个单词 欠规范代码示例: com.lxit.daoImpl 单词大写了,daoImpl多个单词 规范代码示例: com.lxit.dao.impl 解析:这是一个大家都

Java高级规范之二

二十一.提交java代码前应该检查是否有没用的语句,如:System.out.println(); jsp页面上面是否有alert调试信息 不规范示例:暂无 规范实例:暂无 解析:因为如果保留了有可能会影响到程序正常运行的结果,如: for(int i=0;i<10;i++){ System.out.println(i); } //如果测试for语句里有没有执行 for(int i=0;i<10;i++){ System.out.println("测试代码是否运行到这里")

java高级规范之一

一.不允许使用汉语拼音命名 不规范示例: public void zengjiaYongHu{}//拼音方法名称 规范示例: public void addUser(){} 解析:应该使用国际化语音,拼音使代码难懂 二.Package名称必须全部小写,尽量使用单个单词 不规范示例: com.Lxit.daoimpl 单词大写了,daolmpl多个单词 规范示例: com.lxit.dao.impl 解析:这是大家都认同的习惯写法,也是个默认的规范 三.局部变量及输入参数不要与类变量同名(get/

Java注释规范整理

在软件开发的过程中总是强调注释的规范,但是没有一个具体的标准进行说明,通常都是在代码编写规范中简单的描述几句,不能作为一个代码注释检查的标准和依据,做什么都要有一个依据吗:),现在我特整理了一个<Java的注释规范>,内容来自网络.书籍和自己的实际积累. JAVA注释规范 版本/状态 作者 版本日期 1.0 ghc 2008-07-02 一.背景 1.当我们第一次接触某段代码,但又被要求在极短的时间内有效地分析这段代码,我们需要什么样的注释信息? 2.怎么样避免我们的注释冗长而且凌乱不堪呢? 

标准的Java编码规范手册

编码规范体现出一个开发者的基本素质,良好的编码规范可以提高团队编码的效率,避免很多不必要的问题.今天分享一个标准的Java编码规范给大家,希望对于大家今后的开发工作带来帮助. 编码规范的意义 在项目开发维护中,编码规范作为开发规范的一个组成部分,是十分重要和必须的,它不仅仅是为了提高开发效率,也有利于降低后期维护开发的成本.编码规范的根本目的就是要让不仅代码可以一目了然,也可以很容易的理解开发人员所编写的代码程的用途和意义.由此,用来减少项目中因为开发维护人员的更替或由于长时间不维护造成的记忆模

点燃java高级架构师的成长之路!

作者:java高级进阶链接:https://www.nowcoder.com/discuss/72575来源:牛客网 金三银四跳槽旺季,每个人都想有一份高薪资,环境好,且稳定的工作,现在已经是四月份了,跳槽旺季还剩最后一个月,你们都准备好了么?你们吃饭的技术过硬么?你们准备好进名企了么?最主要的是,你们是一名资深架构师么?想成为架构师么?还是继续每天坚持加班的桥写代码??????这些问题,只有你们能明白且自己解决. 现在正是需要我们认真考虑的时候,要如何提高我们的编程能力,要怎样努力才可以成为一

转:成为Java高级程序员需要掌握哪些?

section 1 1.Core Java,就是Java基础.JDK的类库,很多童鞋都会说,JDK我懂,但是懂还不足够,知其然还要知其所以然,JDK的源代码写的非常好,要经常查看,对使用频繁的类,比如String,集合类(List,Map,Set)等数据结构要知道它们的实现,不同的集合类有什么区别,然后才能知道在一个具体的场合下使用哪个集合类更适合.更高效,这些内容直接看源代码就OK了 2.多线程并发编程,现在并发几乎是写服务端程序必须的技术,那对Java中的多线程就要有足够的熟悉,包括对象锁机

怎么成为java高级架构师?图灵学院总结的java架构师学习路线

怎么成为一个java高级架构师呢?相信这是很多java从业者,又或者说是coder/码农们比较感兴趣的问题,要回答这个问题,首先需要明白的是java架构师是什么?简单点说,架构师的主要任务不是从事具体的软件程序的编写,而是从事更高层次的开发构架工作.主要着眼于系统的"技术实现",工作内容就是确认和评估系统需求,给出开发规范,搭建系统实现的核心构架,并澄清技术细节.扫清主要难点的技术人员,并且需要有良好的组织管理能力.因此应该是特定的开发平台.语言.工具的大师,对常见应用场景能马上给出最