Java编程最差实践常见问题详细说明(1)转
Java编程最差实践常见问题详细说明(1)转
每天在写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();
- }
捕获所有的异常 错误的写法:

- Query q = ...
- Person p;
- try {
- p = (Person) q.getSingleResult();
- } catch(Exception e) {
- p = null;
- }
这是EJB3的一个查询操作, 可能出现异常的原因是: 结果不唯一; 没有结果; 数据库无法访问, 而捕获所有的异常, 设置为null将掩盖各种异常情况. 正确的写法:

- Query q = ...
- Person p;
- try {
- p = (Person) q.getSingleResult();
- } catch(NoResultException e) {
- p = null;
- }
忽略所有异常

- try {
- doStuff();
- } catch(Exception e) {
- log.fatal("Could not do stuff");
- }
- doMoreStuff();
这个代码有两个问题, 一个是没有告诉调用者, 系统调用出错了. 第二个是日志没有出错原因, 很难跟踪定位问题. 正确的写法:

- try {
- doStuff();
- } catch(Exception e) {
- throw new MyRuntimeException("Could not do stuff because: "+ e.getMessage, e);
- }
重复包装RuntimeException 错误的写法:

- try {
- doStuff();
- } catch(Exception e) {
- throw new RuntimeException(e);
- }
正确的写法:

- try {
- doStuff();
- } catch(RuntimeException e) {
- throw e;
- } catch(Exception e) {
- throw new RuntimeException(e.getMessage(), e);
- }
- try {
- doStuff();
- } catch(IOException e) {
- throw new RuntimeException(e.getMessage(), e);
- } catch(NamingException e) {
- throw new RuntimeException(e.getMessage(), e);
- }
不正确的传播异常 错误的写法:

- try {
- } catch(ParseException e) {
- throw new RuntimeException();
- throw new RuntimeException(e.toString());
- throw new RuntimeException(e.getMessage());
- throw new RuntimeException(e);
- }
主要是没有正确的将内部的错误信息传递给调用者. 第一个完全丢掉了内部错误信息, 第二个错误信息依赖toString方法, 如果没有包含最终的嵌套错误信息, 也会出现丢失, 而且可读性差. 第三个稍微好一些, 第四个跟第二个一样. 正确的写法:

- try {
- } catch(ParseException e) {
- throw new RuntimeException(e.getMessage(), e);
- }
用日志记录异常 错误的写法:

- try {
- ...
- } catch(ExceptionA e) {
- log.error(e.getMessage(), e);
- throw e;
- } catch(ExceptionB e) {
- log.error(e.getMessage(), e);
- throw e;
- }
一般情况下在日志中记录异常是不必要的, 除非调用方没有记录日志.
异常处理不彻底 错误的写法:

- try {
- is = new FileInputStream(inFile);
- os = new FileOutputStream(outFile);
- } finally {
- try {
- is.close();
- os.close();
- } catch(IOException e) {
- /* we can't do anything */
- }
- }
is可能close失败, 导致os没有close 正确的写法:

- try {
- is = new FileInputStream(inFile);
- os = new FileOutputStream(outFile);
- } finally {
- try { if (is != null) is.close(); } catch(IOException e) {/* we can't do anything */}
- try { if (os != null) os.close(); } catch(IOException e) {/* we can't do anything */}
- }
捕获不可能出现的异常 错误的写法:

- try {
- ... do risky stuff ...
- } catch(SomeException e) {
- // never happens
- }
- ... do some more ...
正确的写法:

- try {
- ... do risky stuff ...
- } catch(SomeException e) {
- // never happens hopefully
- throw new IllegalStateException(e.getMessage(), e); // crash early, passing all information
- }
- ... do some more ...
transient的误用 错误的写法:

- public class A implements Serializable {
- private String someState;
- private transient Log log = LogFactory.getLog(getClass());
- public void f() {
- log.debug("enter f");
- ...
- }
- }
这里的本意是不希望Log对象被序列化. 不过这里在反序列化时, 会因为log未初始化, 导致f()方法抛空指针, 正确的做法是将log定义为静态变量或者定位为具备变量. 正确的写法:

- public class A implements Serializable {
- private String someState;
- private static final Log log = LogFactory.getLog(A.class);
- public void f() {
- log.debug("enter f");
- ...
- }
- }
- public class A implements Serializable {
- private String someState;
- public void f() {
- Log log = LogFactory.getLog(getClass());
- log.debug("enter f");
- ...
- }
- }
不必要的初始化 错误的写法:

- public class B {
- private int count = 0;
- private String name = null;
- private boolean important = false;
- }
这里的变量会在初始化时使用默认值:0, null, false, 因此上面的写法有些多此一举. 正确的写法:

- public class B {
- private int count;
- private String name;
- private boolean important;
- }
最好用静态final定义Log变量

- private static final Log log = LogFactory.getLog(MyClass.class);
这样做的好处有三:
- 可以保证线程安全
- 静态或非静态代码都可用
- 不会影响对象序列化
选择错误的类加载器
错误的代码:

- Class clazz = Class.forName(name);
- Class clazz = getClass().getClassLoader().loadClass(name);
这里本意是希望用当前类来加载希望的对象, 但是这里的getClass()可能抛出异常, 特别在一些受管理的环境中, 比如应用服务器, web容器, Java WebStart环境中, 最好的做法是使用当前应用上下文的类加载器来加载. 正确的写法:

- ClassLoader cl = Thread.currentThread().getContextClassLoader();
- if (cl == null) cl = MyClass.class.getClassLoader(); // fallback
- Class clazz = cl.loadClass(name);
Java编程最差实践常见问题详细说明(1)转的更多相关文章
- Java编程最差实践常见问题详细说明(2)转
Java编程最差实践常见问题详细说明(2)转 2012-12-13 13:57:20| 分类: JAVA | 标签:java |举报|字号 订阅 反射使用不当 错误的写法: Java代 ...
- Java编程最差实践(常见编程错误典范)
转载自 http://macrochen.iteye.com/blog/1393502 每天在写Java程序,其实里面有一些细节大家可能没怎么注意,这不,有人总结了一个我们编程中常见的问题.虽然一般 ...
- Java编程最差实践
原文地址:http://www.odi.ch/prog/design/newbies.php 每天在写Java程序, 其实里面有一些细节大家可能没怎么注意, 这不, 有人总结了一个我们编程中常见的问题 ...
- Java编程中的一些常见问题汇总
转载自 http://macrochen.iteye.com/blog/1393502 每天在写Java程序,其实里面有一些细节大家可能没怎么注意,这不,有人总结了一个我们编程中常见的问题.虽然一般 ...
- Java编程最差代码
字符串连接误用 错误的写法: String s = ""; for (Person p : persons) { s += ", " + p.getName( ...
- [Java并发编程(四)] Java volatile 的理论实践
[Java并发编程(四)] Java volatile 的理论实践 摘要 Java 语言中的 volatile 变量可以被看作是一种 "程度较轻的 synchronized":与 ...
- Java 编程中关于异常处理的 10 个最佳实践
异常处理是Java 开发中的一个重要部分.它是关乎每个应用的一个非功能性需求,是为了处理任何错误状况,比如资源不可访问,非法输入,空输入等等.Java提供了几个异常处理特性,以try,catch 和 ...
- 【转】JAVA学习笔记----PL/SQL最差实践
1. 超长的PL/SQL代码 影响:可维护性,性能 症状: 在复杂的企业应用中,存在动辄成百上千行的存储过程或上万行的包.为什么是最差: 太长的PL/SQL代码不利于阅读,第三方工 ...
- 零基础从实践出发学java编程【总结篇】
1.背景 很多人学习java的第一步就是系统的学习java基础语法,有的java基础语法还没学完就崩溃了,确实java基础语法太多太细,而且都是理论,学着让人很懵: 好不容易学完基础语法,又要学框架. ...
随机推荐
- rabbitmq系列(四)死信队列
一.什么是死信队列 当消息在一个队列中变成一个死信之后,它将被重新publish到另一个交换机上,这个交换机我们就叫做死信交换机,私信交换机将死信投递到一个队列上就是死信队列.具体原理如下图: 消息变 ...
- Natas4 Writeup(Referer篡改)
Natas4: 提示来源出错,合法用户只能来自"http://natas5.natas.labs.overthewire.org/". 在http的header中,referer代 ...
- 大牛都在用的IDEA调试技巧
导读 前天面试了一个985高校的实习生,问了他平时用什么开发工具,他想也没想的说IDEA,于是我抛砖引玉的问了一下IDEA的调试用过吧,你说说怎么设置断点条件?那孩子懵了,想了好一会对我说没用过,甚至 ...
- 深入分析mysql为什么不推荐使用uuid或者雪花id作为主键
前言:在mysql中设计表的时候,mysql官方推荐不要使用uuid或者不连续不重复的雪花id(long形且唯一),而是推荐连续自增的主键id,官方的推荐是auto_increment,那么为什么不建 ...
- SpringMVC框架——常用注解
@RequestMapping Spring MVC 通过 @RequestMapping 注解将请求与业务方法进行映射,在方法定义处,在类定义都可以添加该注解. 常用参数: 1.value:指定请求 ...
- Hive面试准备
Hive与HBase的区别Hive架构原理Hive的数据模型及各模块的应用场景Hive支持的文件格式和压缩格式及各自特点Hive内外表的区分方法及内外部差异Hive视图如何创建.特点及应用场景Hive ...
- 推荐系统(Recommender Systems)
本博客是针对Andrew Ng在Coursera上的machine learning课程的学习笔记. 目录 基于内容的推荐(Content-based recommendation) 问题表述 问题范 ...
- [leetcode] 位操作题解-2
本文是 leetcode 位操作题库的题目解析.点击每个标题可进入题目页面. 重复的DNA序列 题目:所有 DNA 都由一系列缩写为 A,C,G 和 T 的核苷酸组成,例如:"ACGAATT ...
- TensorFlow 神经机器教程-TensorFlow Neural Machine Translation Tutorial
seq2seq 模型在广泛的任务比如机器翻译,语音识别,文本总结中取得了巨大的成功.这个教程给读者 seq2seq 模型一个完整的理解,并且展示如何从原型建立一个有竞争力的 seq2seq 模型.我们 ...
- zookeeper 负载均衡
1,原理 将启动的服务注册到zookeeper 注册中心上面,采用临时节点,zookeeper 客户端从注册中心上读取服务的信息,之后再本地采用负载均衡算法(取模算法),将请求轮询到每个服务. 同时z ...