每天在写Java程序, 其实里面有一些细节大家可能没怎么注意, 这不, 有人总结了一个我们编程中常见的问题. 虽然一般没有什么大问题, 但是最好别这样做.
    另外这里提到的很多问题其实可以通过Findbugs( http://findbugs.sourceforge.net/ )来帮我们进行检查出来.

字符串连接误用

 错误的写法:

String s = "";  
for (Person p : persons) {  
    s += ", " + p.getName();  
}  
s = s.substring(2); //remove first comma

正确的写法:

StringBuilder sb = new StringBuilder(persons.size() * 16); // well estimated buffer  
for (Person p : persons) {  
    if (sb.length() > 0) sb.append(", ");  
    sb.append(p.getName);  
}

错误的使用StringBuffer

错误的写法:

StringBuffer sb = new StringBuffer();  
sb.append("Name: ");  
sb.append(name + '\n');  
sb.append("!");  
...  
String s = sb.toString();

    问题在第三行, append char比String性能要好, 另外就是初始化StringBuffer没有指定size, 导致中间append时可能重新调整内部数组大小. 如果是JDK1.5最好用StringBuilder取代StringBuffer, 除非有线程安全的要求. 还有一种方式就是可以直接连接字符串. 缺点就是无法初始化时指定长度.

正确的写法:

StringBuilder sb = new StringBuilder(100);  
sb.append("Name: ");  
sb.append(name);  
sb.append("\n!");  
String s = sb.toString();

或者这样写:

String s = "Name: " + name + "\n!";

测试字符串相等性

错误的写法:

if (name.compareTo("John") == 0) ...  
if (name == "John") ...  
if (name.equals("John")) ...  
if ("".equals(name)) ...

    上面的代码没有错, 但是不够好. compareTo不够简洁, ==原义是比较两个对象是否一样. 另外比较字符是否为空, 最好判断它的长度.

正确的写法:

if ("John".equals(name)) ...  
if (name.length() == 0) ...  
if (name.isEmpty()) ...

数字转换成字符串

错误的写法:

"" + set.size()  
new Integer(set.size()).toString()

正确的写法:

String.valueOf(set.size())

利用不可变对象(Immutable)

错误的写法:

zero = new Integer(0);  
return Boolean.valueOf("true");

正确的写法:

zero = Integer.valueOf(0);  
return Boolean.TRUE;

请使用XML解析器

错误的写法:

int start = xml.indexOf("<name>") + "<name>".length();  
int end = xml.indexOf("</name>");  
String name = xml.substring(start, end);

正确的写法:

SAXBuilder builder = new SAXBuilder(false);  
Document doc = doc = builder.build(new StringReader(xml));  
String name = doc.getRootElement().getChild("name").getText();

请使用JDom组装XML

错误的写法:

String name = ...  
String attribute = ...  
String xml = "<root>"  
            +"<name att=\""+ attribute +"\">"+ name +"</name>"  
            +"</root>";

正确的写法:

Element root = new Element("root");  
root.setAttribute("att", attribute);  
root.setText(name);  
Document doc = new Documet();  
doc.setRootElement(root);  
XmlOutputter out = new XmlOutputter(Format.getPrettyFormat());  
String xml = out.outputString(root);

XML编码陷阱

错误的写法:

String xml = FileUtils.readTextFile("my.xml");

    因为xml的编码在文件中指定的, 而在读文件的时候必须指定编码. 另外一个问题不能一次就将一个xml文件用String保存, 这样对内存会造成不必要的浪费, 正确的做法用InputStream来边读取边处理. 为了解决编码的问题, 最好使用XML解析器来处理

未指定字符编码

错误的写法:

Reader r = new FileReader(file);  
Writer w = new FileWriter(file);  
Reader r = new InputStreamReader(inputStream);  
Writer w = new OutputStreamWriter(outputStream);  
String s = new String(byteArray); // byteArray is a byte[]  
byte[] a = string.getBytes();

    这样的代码主要不具有跨平台可移植性. 因为不同的平台可能使用的是不同的默认字符编码.

正确的写法:

Reader r = new InputStreamReader(new FileInputStream(file), "ISO-8859-1");  
Writer w = new OutputStreamWriter(new FileOutputStream(file), "ISO-8859-1");  
Reader r = new InputStreamReader(inputStream, "UTF-8");  
Writer w = new OutputStreamWriter(outputStream, "UTF-8");  
String s = new String(byteArray, "ASCII");  
byte[] a = string.getBytes("ASCII");

未对数据流进行缓存

错误的写法:

InputStream in = new FileInputStream(file);  
int b;  
while ((b = in.read()) != -1) {  
   ...  
}

    上面的代码是一个byte一个byte的读取, 导致频繁的本地JNI文件系统访问, 非常低效, 因为调用本地方法是非常耗时的. 最好用BufferedInputStream包装一下. 曾经做过一个测试, 从/dev/zero下读取1MB, 大概花了1s, 而用BufferedInputStream包装之后只需要60ms, 性能提高了94%! 这个也适用于output stream操作以及socket操作.

正确的写法:

InputStream in = new BufferedInputStream(new FileInputStream(file));

无限使用heap内存

错误的写法:

byte[] pdf = toPdf(file);

    这里有一个前提, 就是文件大小不能讲JVM的heap撑爆. 否则就等着OOM吧, 尤其是在高并发的服务器端代码. 最好的做法是采用Stream的方式边读取边存储(本地文件或database).

正确的写法:

File pdf = toPdf(file);

    另外, 对于服务器端代码来说, 为了系统的安全, 至少需要对文件的大小进行限制.

不指定超时时间

错误的代码:

Socket socket = ...  
socket.connect(remote);  
InputStream in = socket.getInputStream();  
int i = in.read();

    这种情况在工作中已经碰到不止一次了. 个人经验一般超时不要超过20s. 这里有一个问题, connect可以指定超时时间, 但是read无法指定超时时间. 但是可以设置阻塞(block)时间.

正确的写法:

Socket socket = ...  
socket.connect(remote, 20000); // fail after 20s  
InputStream in = socket.getInputStream();  
socket.setSoTimeout(15000);  
int i = in.read();

    另外, 文件的读取(FileInputStream, FileChannel, FileDescriptor, File)没法指定超时时间, 而且IO操作均涉及到本地方法调用, 这个更操作了JVM的控制范围, 在分布式文件系统中, 对IO的操作内部实际上是网络调用. 一般情况下操作60s的操作都可以认为已经超时了. 为了解决这些问题, 一般采用缓存和异步/消息队列处理.

频繁使用计时器

错误的代码:

for (...) {  
  long t = System.currentTimeMillis();  
  long t = System.nanoTime();  
  Date d = new Date();  
  Calendar c = new GregorianCalendar();  
}

    每次new一个Date或Calendar都会涉及一次本地调用来获取当前时间(尽管这个本地调用相对其他本地方法调用要快).
    如果对时间不是特别敏感, 这里使用了clone方法来新建一个Date实例. 这样相对直接new要高效一些.

正确的写法:

Date d = new Date();  
for (E entity : entities) {  
  entity.doSomething();  
  entity.setUpdated((Date) d.clone());  
}

    如果循环操作耗时较长(超过几ms), 那么可以采用下面的方法, 立即创建一个Timer, 然后定期根据当前时间更新时间戳, 在我的系统上比直接new一个时间对象快200倍:

private volatile long time;  
Timer timer = new Timer(true);  
try {  
  time = System.currentTimeMillis();  
  timer.scheduleAtFixedRate(new TimerTask() {  
    public void run() {  
      time = System.currentTimeMillis();  
    }  
  }, 0L, 10L); // granularity 10ms  
  for (E entity : entities) {  
     entity.doSomething();  
     entity.setUpdated(new Date(time));  
  }  
} finally {  
  timer.cancel();  
}