J2EE项目实训Struts框架技术——第8章 重构和完善BBS论坛系统(第1部分)

第8章重构和完善BBS论坛系统（第1/3部分）通过本书前7章的各个章节内容的学习，相信读者对Struts框架应该有了一定的了解，同时也对Struts框架在实际项目中的具体应用也有所体验。

读者随着对本书各个章节中所涉及的与Struts框架及软件开发有关的知识学习的深入，BBS论坛系统的功能实现也不断地丰富和完善。

但论坛系统中的程序代码量也在不断地膨胀，相应地隐藏在程序中的各种缺陷也在不断地累积。

现在需要考虑如何对BBS论坛系统的内部结构进行调整和改造完善，从而使得论坛系统的程序结构关系更加清晰明了，也就是需要重构和完善BBS论坛系统——保持系统中的各个功能实现类代码更加易读和易维护修改，从而减少系统中的隐藏错误。

软件重构技术（Refactoring）是目前软件工程中比较热门的一个技术话题，软件重构是对软件系统的内部结构所作的一种调整改变，但对外所体现出的可见功能不变。

当然，软件重构不只是简单地整理系统中的各个功能实现代码，同时也能够消除系统中重复和不良功能实现的代码。

本章以重构和完善BBS论坛系统为示例，系统地介绍软件重构技术及在项目中具体的实际应用、Eclipse开发工具对重构技术的支持等方面的内容。

通过对BBS论坛系统实施代码重构，从而提高BBS论坛系统中的各个功能实现的程序代码可读性和可维护性、可扩展性和可重用性，并降低对整个项目的维护修改的成本。

1.1软件重构技术尽管有关软件重构技术的话题目前比较热门，但到现在为此，业界还没有对软件重构的概念给出标准的定义。

在许多有关软件重构的定义中，最先对软件系统重构进行理论研究的是Raloh Johnson，他对软件重构所给出的定义是最具有一定的说服力：重构是以各种方式对一对象设计进行重新安排，使之更灵活并且/或者可重用的过程，效率和可维护性可能是进行重构最重要的理由。

而面向对象设计技术的大师Martin Fowle给出更一般的定义[Fow99]，他把重构定义为名词形式和动词形式两部分：重构（Refactoring作为名词）——是对软件的内部结构所作的一种改变，这种改变在可观察行为（Observable Behaviour）不变的条件下使软件更容易理解，而且修改更廉价。

重构（Refactor作为动词）——应用一系列不改变软件可观察行为的重构操作对软件进行重新组织（Restructure）。

软件系统的开发人员为什么要对现有运行结果正常的应用系统功能实现程序进行重构操作呢？是否有必要或者多此一举呢？通过对软件系统进行持续的重构操作行为，可以改进现有的软件应用系统的功能程序的设计、并且可以使得功能实现代码更易可读和理解；当然，通过重构操作也可以找出潜伏和隐藏在软件应用系统中的缺陷（Bugs或者臭虫）、从而减少在系统调试和系统集成测试中所花的时间开销。

1.1.1软件重构技术及应用1、软件重构技术1）什么是软件重构技术软件重构是指在不改变应用系统中程序代码的外在功能行为的前提下，对应用系统中的各个功能实现的程序代码进行修改，以便改进程序代码的内部结构，从而提高这些功能实现程序代码的可读性和可维护性、可扩展性和可重用性的过程。

简而言之，重构就是改进已经编程实现了的软件系统中已经存在的程序设计。

其本质是一种在完成代码的编程实现之后，如何对其进行调整和优化的设计方法。

2）软件开发的四步曲——“系统设计、功能编码、单元测试与代码重构”按照软件工程中所描述的软件开发过程，应该是“先设计而后编码实现”。

而且只有在获得一个良好的设计方案以后，才能开展编码的工作；但是，随着开发过程的不断推进和开发工作的深入，开发人员也在不断地修改或者调整原有的功能实现代码，于是依据原先的设计方案而编程实现的系统程序代码的整体结构也在逐渐混乱和难懂、代码的质量也在慢慢地降低，编码工作逐步地进入一种无序状态。

“测试为先，持续重构”作为良好的软件开发方式被越来越多的开发人员所采纳。

当开发人员意识到应用系统的功能实现代码进入这样的状况时，就应该要暂停现有的软件开发实现的过程而好好地审视系统中目前的程序代码结构关系，应该考虑是否有必要对项目中的各个功能代码的重构工作。

2、软件重构技术的主要作用及目的1）软件重构能够改善程序代码的结构尽管软件系统的设计不良好和存在一定的缺陷，但开发人员仍然可以藉由软件重构技术将该软件系统加工成设计良好的功能代码，因为通过重构能够改善程序代码的内部结构关系、并减少重复的代码，从而也就完善了软件系统的设计。

而且由于在进行重构时的每个实现步骤都很简单，比如开发人员只需要把某个类成员属性变量从一个类转移到另一个类中、把某些代码从一个方法抽起出来而构成另一个方法，或是在类的继承关系树中，将代码上移到基类或者下推到子类；通过这样的“聚沙成塔”形式的修改和结构完善的行为，而逐步地累积起来就可以从根本上改善现有软件系统的设计质量和获得一个结构更加清晰的程序代码。

2）软件重构的主要目的通过对软件应用系统进行重构操作能够保持应用系统中的功能实现代码更加易读和易维护修改，重构的目标是在不影响程序的对外可见功能行为的前题下进行系统范围内的功能实现的代码更改和调整。

因为随着开发过程的深入，开发人员经常会将自己所开发出的各个功能实现代码趋向于采用更庞大的类、更长的成员方法、更多的开关语句和更深的条件嵌套语句等形式来加以实现。

这样的功能实现代码不仅难以理解，也更难于修改和扩展；另外，一个软件系统很难做到一开始就是很完善和完美的，通过对应用系统中的功能实现代码不断地进行重构的过程，使得软件系统中的程序代码更容易被理解、也更容易找出其中的缺陷（Bug）。

而对代码进行持续地重构操作，也就可以深入地理解各个代码的功能和搞清楚程序的结构和各个模块之间的关系。

因为开发人员编程实现的代码不只是简单地被执行，也还可能需要进行交流和被其他的程序员阅读和理解。

通过不断地进行重构过程，当然也就可以让代码更好地表达开发者的思想和意图。

3）重构不仅仅只是整理代码，同时也能够消除重复代码软件重构技术提供了一种更高效的代码整理技术。

充分运用重构技术，对代码的整理会比常规的方法更有效率；重构不会改变软件对外所体现出的功能行为，重构之后的软件功能一如既往。

软件系统越庞大，重构越显得很有必要。

尽管代码数量的减少并不会使软件系统的运行速度明显地提高，因为现在的计算机的主频是如此高。

然而程序代码的数量减少将使软件系统在未来可能的修改行为或者系统的维护升级更加容易。

因为代码愈多，正确地进行修改当然也就愈困难——开发人员需要理解更多的程序代码。

3、为什么不将设计做的完美，而要以后再花时间来重构系统呢？1）不存在完美的软件设计结果也许读者会问，为什么不在软件项目开始时多花些时间来把系统的设计做好和进行完美的系统设计，而要以后再花时间来重构系统呢？读者应该知道，一个完美得可以预见未来任何变化的软件系统的设计，或一个灵活得可以容纳任何扩展要求的设计是理想化的、也是不存在的——因为设计师不是“神”。

2）软件系统的需求也是不断地变化的软件系统的设计人员在进行项目的设计时，往往只能在大的方向方面或者系统中的主要功能模块方面把控软件系统，而很难知道软件系统中的每个细枝末节，软件系统的完善和改进将应该伴随着软件开发的各个环节和过程中——“测试为先，持续重构”；其次永远不变的就是“变化”——软件系统的需求（功能方面或者性能方面）也是不断地变化的，由于功能的变化而导致对系统的设计进行调整和完善也是不可避免的。

4、不良好的程序实现代码示例1）在控制层Servlet组件中直接访问数据库表中的数据在J2EE平台的应用系统开发中，倡导“多层架构、松藕合”的软件系统开发原则。

因此，不应该在系统的控制层组件如Servlet类或者Struts框架的Action类中出现有持久层的功能实现代码。

下面的【例8-1】所示的代码示例是一个不良好的程序代码，因为在控制层Servlet组件中直接访问数据库系统中的数据而导致系统的控制层的功能实现和持久层紧密关联。

对这样的功能实现代码，开发者当然应该要进行重构操作以对其进行完善。

【例8-1】在控制层Servlet组件中直接访问数据库系统的不良好的程序代码示例public void doPost(HttpServletRequest request,HttpServletResponse response)throws ServletException,IOException{Connection connection;String userName =request.getParameter("userName");String userPassword =request.getParameter("userPassword");try {Class.forName("org.gjt.mm.mysql.Driver");connection = DriverManager.getConnection(url,sqluserName, sqlPassWord);} catch (ClassNotFoundException ex) {System.out.println("装载驱动程序失败");} catch (SQLException e) {System.out.println("无法连接数据库");}//。

对数据库表中的数据，进行访问的其它部分的功能实现代码，在此省略未附录出}2）在表示层页面中包含有大量的服务器端的脚本代码从职责合理地分配的角度来看下面【例8-2】所示的用户注册功能的JSP页面的实现，为什么是不良好的设计实现？因为在表示层页面中包含有大量的服务器端脚本代码，将导致表示层组件与系统中的业务功能处理实现紧密关联，不利于表示层的开发和维护，也降低了页面的可读性。

当然对这样的页面设计的功能实现代码，开发者当然也应该要进行重构操作以实现页面标签和功能实现的脚本代码之间相互分离。

【例8-2】在表示层页面中包含有大量的服务器端脚本代码的不良好的页面示例<%@ page contentType="text/html;charset=gb2312"%><%@ page import="java.sql.*"%><jsp:useBean id="userInfoBeanID" scope="page" class="webmisbean.WebMisBean"/><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head></head><body><%!String userName,userPassword,userDepartment;String userAdminLevel,departAdminLevel;int wUserLevel,wDepartLevel;ResultSet rs=null;Connection con=null;PreparedStatement ps=null;String selectSQL,insertSql;%><%request.setCharacterEncoding("gb2312");userName=request.getParameter("userName").trim();userPassword=request.getParameter("userPassword").trim();userDepartment = request.getParameter("userDepartment").trim();userAdminLevel = request.getParameter("userAdminLevel").trim();departAdminLevel = request.getParameter("departAdminLevel").trim();wUserLevel=Integer.parseInt(userAdminLevel);wDepartLevel=Integer.parseInt(departAdminLevel);insertSql="insert into userInfoTable values(?,?,?,?,?)";con=userInfoBeanID.getConnection();ps=con.prepareStatement(insertSql);ps.setString(1,userName);ps.setString(2,userPassword);ps.setString(3,userDepartment);ps.setInt(4,wUserLevel);ps.setInt(5,wDepartLevel);ps.executeUpdate();userInfoBeanID.close();%></body></html>3）不正确的程序包的命名在下图8.1中展示了某个应用系统中所存在的不正确包的命名状况，因为在该系统中将持久层中的各个组件类（如connDB.java、MysqlconnDB.java和SqlserverconnDB.java）与业务层中的各个组件类（如productBean.java、orderManagerBean、userManagerBean.java等）位于同一个子包中。