1 Jive功能需求
Jive功能需求分析类似于一个新系统的需求分析。只有了解Jive系统实现了哪些论坛功能,才能进一步研究和学习它是怎样
巧妙、优雅地实现这些功能的。


在Jive论坛系统中,用户角色和权限是紧密联系在一起的。主要分两大角色:普通用户和管理员,具体的表现形式是通过权限组合来体现的。管理方面的权限有:

         SYSTEM_ADMIN,系统管理员,可以管理整个系统。

          FORUM_ADMIN,论坛管理员,可以管理某个特定的论坛。

          USER_ADMIN和GROUP_ADMIN,用户和组管理员,可以管理一些特定用户和用户组。

论坛的读写权限包括:读权限,创建一个新主题,创建一个新的帖子等。

Jive中没有明确定义普通用户和管理员角色,而是直接通过以上权限组合和具体用户直接建立联系,并将这种直接联系保存到数据库中。

在权限不是很复杂的情况下,这种没有引入角色的做法比较简单直接。但由于用户和权限直接挂钩,而用户和权限都可能在不断地动态变化,那么它们之间由于联系太直接和紧密,对各自变化形成了限制。所以,对于复杂的权限系统,引入了基于角色的权限系统,这将在以后章节中进一步讨论。

Jive论坛业务对象主要分为ForumForumThreadForumMessage,它们之间的关系如图3-2所示。

每个论坛Forum包含一系列ForumThread(主题),而每个主题都是由很多内容帖子ForumMessage组成的,这是一个聚集关系。这3种对象中每一个对象都涉及到对象数据的创建、编辑、查询和删除,这些对象数据分别保存在数据库中。这3个对象对于不同的角色可操作访问权限是不一样的,只有系统管理员和论坛管理员可以对Forum相关数据实行操作,普通用户可以创建或编辑ForumThreadForumMessage

Jive论坛为了实现不同用户对不同基本对象的不同操作权限,通过设定一个统一的入口,在这个入口将检查客户端每次对数据的操作权限,如图3-3所示。

        

客户端每次对数据库的操作,都要经过ForumFactory入口进入。在ForumFactory中会动态生成一个访问控制代理ForumFactoryProxy,通过ForumFactoryProxy检查客户端访问方法是否符合整体权限访问控制要求。

ForumFactory与工厂模式

GOF设计模式中,工厂模式分为工厂方法模式和抽象工厂模式。两者主要区别是,工厂方法是创建一种产品接口下的产品对象,而抽象工厂模式是创建多种产品接口下的产品对象,非常类似Builder生成器模式。在平时实践中,使用较多的基本是工厂方法模式。

以类SampleOne为例,要创建SampleOne的对象实例:

SampleOne sampleOne = new SampleOne();

如果Sample类有几个相近的类:SampleTwoSampleThree,那么创建它们的实例分别是:

SampleTwo sampleTwo = new SampleTwo();

SampleThree sampleThree = new SampleThree();

其实这3个类都有一些共同的特征,如网上商店中销售书籍、玩具或者化妆品。虽然它们是不同的具体产品,但是它们有一个共同特征,可以抽象为“商品”。日常生活中很多东西都可以这样高度抽象成一种接口形式。上面这3个类如果可以抽象为一个统一接口SampleIF,那么上面语句就可以成为:

SampleIF sampleOne = new SampleOne();

SampleIF sampleTwo = new SampleTwo();

SampleIF sampleThree = new SampleThree();

在实际情况中,有时并不需要同时生成3种对象,而是根据情况在3者之中选一个。在这种情况下,需要使用工厂方法来完成了,创建一个叫SampleFactory的抽象类:

public class SampleFactory{

   public abstract SampleIF creator();

}

在这个抽象工厂类中有一个抽象方法creator,但是没有具体实现,而是延迟到它的子类中实现,创建子类SampleFactoryImp

public class SampleFactoryImp extends SampleFactory{

   public SampleIF creator(){

    //根据其他因素综合判断返回具体产品

    //假设应该返回SampleOne对象

       return new SampleOne();

}

}

SampleFactoryImp中根据具体情况来选择返回SampleOneSampleTwoSampleThree。所谓具体情况有很多种:上下文其他过程计算结果;直接根据配置文件中配置。

上述工厂方法模式中涉及到一个抽象产品接口Sample,如果还有其他完全不同的产品接口,如Product等,一个子类SampleFactoryImp只能实现一套系列产品方案的生产,如果还需要另外一套系统产品方案,就可能需要另外一个子类SampleFactoryImpTwo来实现。这样,多个产品系列、多个工厂方法就形成了抽象工厂模式。
前面已经讨论在Jive中设置了论坛统一入口,这个统一入口就是ForumFactory,以下是ForumFactory的主要代码:

public abstract class ForumFactory {

  
private static Object initLock = new Object();
  
private static String className = " com.Yasna.forum.database.DbForumFactory";
  
private static ForumFactory factory = null
  
public static ForumFactory getInstance(Authorization authorization) {
    
if (authorization == null{
      
return null;
    }

    
//以下使用了Singleton 单态模式,将在2.3节讨论
    if (factory == null{
      
synchronized(initLock) {
        
if (factory == null{
             
//从配置文件中获得当前className
          try {
             
//动态装载类

              Class c 
= Class.forName(className);

              factory 
= (ForumFactory)c.newInstance();
          }

          
catch (Exception e) {

              
return null;
          }

        }

      }

    }

    
//返回 proxy.用来限制授权对forum的访问
    return new ForumFactoryProxy(authorization, factory,factory.getPermissions(authorization));
  }


 
//创键产品接口Forum的具体对象实例

  
public abstract Forum createForum(String name, String description)

  
throws UnauthorizedException, ForumAlreadyExistsException;

   
//创键产品接口ForumThread的具体对象实例

public abstract ForumThread createThread(ForumMessage rootMessage) 

throws UnauthorizedException;

//创键产品接口ForumMessage的具体对象实例ForumFactory中却不立即执行,而是推迟到ForumFactory子类中实现。 




ForumFactory的子类实现是com.Yasna.forum.database.DbForumFactory,这是一种数据库实现方式。即在DbForumFactory中分别实现了在数据库中createForum、createThread和createMessage()等3种方法,当然也提供了动态扩展到另外一套系列产品的生产方案的可能。如果使用XML来实现,那么可以编制一个XmlForumFactory的具体工厂子类来分别实现3种创建方法。
因此,Jive论坛在统一入口处使用了抽象工厂模式来动态地创建论坛中所需要的各种产品

XmlForumFactory和DbForumFactory作为抽象工厂ForumFactory的两个具体实现,而Forum、ForumThread和ForumMessage分别作为3个系列抽象产品接口,依靠不同的工厂实现方式,会产生不同的产品对象。

从抽象工厂模式去理解Jive论坛统一入口处,可以一步到位掌握了几个类之间的大概关系。因为使用了抽象工厂模式这种通用的设计模式,可以方便源码阅读者快速地掌握整个系统的结构和来龙去脉,这张图已经初步展示了Jive的主要框架结构。

统一入口与单态模式
在上面ForumFactory的getInstance方法使用单态(SingleTon)模式。单态模式是保证一个类有且仅有一个对象实例,并提供一个访问它的全局访问点。

前面曾提到ForumFactory是Jive提供客户端访问数据库系统的统一入口。为了保证所有的客户端请求都要经过这个ForumFactory,如果不使用单态模式,客户端下列调用语句表示生成了ForumFactory实例:
ForumFactory factory = new DbForumFactory();

客户端每发生一次请求都调用这条语句,这就会发生每次都生成不同factory对象实例,这显然不符合设计要求,因此必须使用单态模式。
一般在Java实现单态模式有几种选择,最常用而且安全的用法如下:

public class Singleton 
  
private Singleton(){}
  
//在自己内部定义自己一个实例,是不是很奇怪

  
//注意这是private,只供内部调用
  private static Singleton instance = new Singleton(); 
  
//这里提供了一个供外部访问本class的静态方法,可以直接访问
  public static Singleton getInstance() 
    
return instance; 
  }
 
}

单态模式一共使用了两条语句实现:第一条直接生成自己的对象,第二条提供一个方法供外部调用这个对象,同时最好将构造函数设置为private,以防止其他程序员直接使用new Singleton生成实例。
还有一种Java单态模式实现:

public class Singleton 
  
private Singleton(){}
  
private static Singleton instance = null
  
public static synchronized Singleton getInstance() 
    
if (instance==null)
      instance=
new Singleton() 
   
return instance; 
  }


在上面代码中,使用了判断语句。如果instance为空,再进行实例化,这成为lazy initialization。注意getInstance()方法的synchronized,这个synchronized很重要。如果没有synchronized,那么使用getInstance()在第一次被访问时有可能得到多个Singleton实例。

关于lazy initialization的Singleton有很多涉及double-checked locking (DCL)的讨论,有兴趣者可以进一步研究。一般认为第一种形式要更加安全些;但是后者可以用在类初始化时需要参数输入的情况下。

在Jive的ForumFactory中采取了后者lazy initialization形式,这是为了能够动态配置指定ForumFactory的具体子类。在getInstance中,从配置文件中获得当前工厂的具体实现,如果需要启动XmlForumFactory,就不必修改ForumFactory代码,直接在配置文件中指定className的名字为XmlForumFactory。这样通过下列动态装载机制生成ForumFactory具体对象:


Class c = Class.forName(className);

factory = (ForumFactory)c.newInstance();

这是利用Java的反射机制,可以通过动态指定className的数值而达到生成对象的方式。

使用单态模式的目标是为了控制对象的创建,单态模式经常使用在控制资源的访问上。例如数据库连接或Socket连接等。单态模式可以控制在某个时刻只有一个线程访问资源。由于Java中没有全局变量的概念,因此使用单态模式有时可以起到这种作用,当然需要注意是在一个JVM中。
 

访问控制与代理模式
仔细研究会发现,在ForumFactory的getInstance方法中最后的返回值有些奇怪。按照单态模式的概念应该直接返回factory这个对象实例,但是却返回了ForumFactoryProxy的一个实例,这实际上改变了单态模式的初衷。这样客户端每次通过调用ForumFactory的getInstance返回的就不是ForumFactory的惟一实例,而是新的对象。之所以这样做是为了访问权限的控制,姑且不论这样做的优劣,先看看什么是代理模式。代理模式是属于设计模式结构型模式中一种,它是实际访问对象的代理对象,或者影子对象,主要达到控制实际对象的访问。这种控制的目的很多,例如提高性能等。即远程代理模式,这种模式将在以后章节讨论。

其中一个主要的控制目的是控制客户端对实际对象的访问权限。在Jive系统中,因为有角色权限的分别,对于Forum、ForumThread和FroumMessage的访问操作必须经过权限机制验证后才能进行。


以ForumFactoryProxy中的createForum方法为例,其实ForumFactoryProxy也是FroumFactory的一种工厂实现,它的createForum具体实现如下:

public Forum createForum(String name, String description)
            
throws UnauthorizedException, ForumAlreadyExistsException
    
{
        
if (permissions.get(ForumPermissions.SYSTEM_ADMIN)) {
            Forum newForum 
= factory.createForum(name, description);
            
return new ForumProxy(newForum, authorization, permissions);
        }

        
else {
            
throw new UnauthorizedException();
        }

}


在这个方法中进行了权限验证,判断是否属于系统管理员。如果是,将直接从DbForumFactory对象factory的方法createForum中获得一个新的Forum对象,然后再返回Forum的子类代理对象ForumProxy。因为在Forum中也还有很多属性和操作方法,这些也需要进行权限验证。ForumProxy和ForumFactoryProxy起到类似的作用。

Jive中有下列几个代理类:

    ForumFactoryProxy:客户端和DbForumFactory之间的代理。客户端访问DbForumFactory的任何方法都要先经过ForumFactoryProxy相应方法代理一次。以下意思相同。
    ForumProxy:客户端和DbForum之间的代理,研究Forum对象的每个方法,必须先看ForumProxy对象的方法。
    ForumMessageProxy:客户端和DbForumMessage之间的代理。
    ForumThreadProxy:客户端和DbForumThread之间的代理。

User和Group也有相应的代理类。

由以上分析看出,每个数据对象都有一个代理。如果系统中数据对象非常多,依据这种一对一的代理关系,会有很多代理类,将使系统变得不是非常干净,因此可以使用动态代理来代替这所有的代理类.


批量分页查询与迭代模式
迭代(Iterator)模式是提供一种顺序访问某个集合各个元素的方法,确保不暴露该集合的内部表现。迭代模式应用于对大量数据的访问,Java Collection API中Iterator就是迭代模式的一种实现。

在前面章节已经讨论过,用户查询大量数据,从数据库不应该直接返回ResultSet,应该是Collection。但是有一个问题,如果这个数据很大,需要分页面显示。如果一下子将所有页面要显示的数据都查询出来放在Collection,会影响性能。而使用迭代模式则不必将全部集合都展现出来,只有遍历到某个元素时才会查询数据库获得这个元素的数据。

以论坛中显示帖子主题为例,在一个页面中不可能显示所有主题,只有分页面显示


一共分15页来显示所有论坛帖子,可以从显示Forum.jsp中发现下列语句可以完成上述结果:

ResultFilter filter = new ResultFilter(); //设置结果过滤器
   filter.setStartIndex(start);             //设置开始点
   filter.setNumResults(range);          //设置范围
   ForumThreadIterator threads = forum.threads(filter); //获得迭代器
   while(threads.hasNext){
       
//逐个显示threads中帖子主题,输出图3-5中的每一行 
   }


上述代码中主要是从Forum的threads方法获得迭代器ForumThreadIterator的实例,依据前面代理模式中分析、研究Forum对象的方法,首先是看ForumProxy中对应方法,然后再看DbForum中对应方法的具体实现。在ForumProxy中,threads方法如下:
public ForumThreadIterator threads(ResultFilter resultFilter) {
     ForumThreadIterator iterator 
= forum.threads(resultFilter);
     
return new ForumThreadIteratorProxy(iterator, authorization, permissions);
}


首先是调用了DbForum中具体的threads方法,再追踪到DbForum中看看,它的threads方法代码如下:
public ForumThreadIterator threads(ResultFilter resultFilter) {
//按resultFilter设置范围要求获得SQL查询语句
   String query = getThreadListSQL(resultFilter, false); 
 
//获得resultFilter设置范围内的所有ThreadID集合
   long [] threadBlock = getThreadBlock(query.toString(), resultFilter.getStartIndex());
   
//以下是计算查询区域的开始点和终点
   int startIndex = resultFilter.getStartIndex();
   
int endIndex;
   
// If number of results is set to inifinite, set endIndex to the total
// number of threads in the forum.
   if (resultFilter.getNumResults() == ResultFilter.NULL_INT) {
     endIndex 
= (int)getThreadCount(resultFilter);
    }
else {
endIndex 
= resultFilter.getNumResults() + startIndex; 
   }

   
return new ForumThreadBlockIterator(threadBlock, query.toString(),
               startIndex, endIndex, 
this.id, factory);
}


ResultFilter是一个查询结果类,可以对论坛主题Thread和帖子内容Message进行过滤或排序,这样就可以根据用户要求定制特殊的查询范围。如查询某个用户去年在这个论坛发表的所有帖子,那只要创建一个ResultFilter对象就可以代表这个查询要求。

在上面threads方法代码中,第一步是先定制出相应的动态SQL查询语句,然后使用这个查询语句查询数据库,获得查询范围内所有的ForumThread的ID集合,然后在这个ID集合中获得当前页面的ID子集合,这是非常关键的一步。

在这关键的一步中,有两个重要的方法getThreadListSQL和getThreadBlock:

    GetThreadListSQL:获得SQL查询语句query的值,这个方法Jive实现起来显得非常地琐碎。

    GetThreadBlock:获得当前页面的ID子集合,那么如何确定ID子集合的开始位置呢?查看getThreadBlock方法代码,可以发现,它是使用最普遍的ResultSet next()方法来逐个跳跃到开始位置。

上面代码的Threads方法中最后返回的是ForumThreadBlockIterator,它是抽象类ForumThreadIterator的子类,而ForumThreadIterator继承了Collection的Iterator,以此声明自己是一个迭代器,ForumMessageBlockIterator实现的具体方法如下:

public boolean hasNext();     //判断是否有下一个元素

public boolean hasPrevious() //判断是否有前一个元素

public Object next() throws java.util.NoSuchElementException //获得下一个元素实例

ForumThreadBlockIterator中的Block是“页”的意思,它的一个主要类变量threadBlock包含的是一个页面中所有ForumThread的ID,next()方法实际是对threadBlock中ForumThread进行遍历,如果这个页面全部遍历完成,将再获取下一页(Block)数据。

在ForumThreadBlockIterator重要方法getElement中实现了两个功能:

       如果当前遍历指针超过当前页面,将使用getThreadBlock获得下一个页面的ID子集合;

       如果当前遍历指针在当前页面之内,根据ID获得完整的数据对象,实现输出;



ForumThreadBlockIterator的getElement方法代码如下:
private Object getElement(int index) {
   
if (index < 0{        return null;        }
   
// 检查所要获得的 element 是否在本查询范围内(当前页面内)
   if (index < blockStart || 
index 
>= blockStart + DbForum.THREAD_BLOCK_SIZE) {   
     
try {
          
//从缓冲中获得Forum实例
          DbForum forum = factory.cacheManager.forumCache.get(forumID);
          
//获得下一页的内容
          this.threadBlock = forum.getThreadBlock(query, index);
          
this.blockID = index / DbForum.THREAD_BLOCK_SIZE; 
this.blockStart = blockID * DbForum.THREAD_BLOCK_SIZE;
      }
 catch (ForumNotFoundException fnfe) {
               
return null;
       }

     }

     Object element 
= null;
     
// 计算这个元素在当前查询范围内的相对位置
     int relativeIndex = index % DbForum.THREAD_BLOCK_SIZE;
     
// Make sure index isn't too large
     if (relativeIndex < threadBlock.length) {
        
try {
            
// 从缓冲中获得实际thread 对象
            element = factory.cacheManager.threadCache.get(
                         threadBlock[relativeIndex]);
        }
 catch (ForumThreadNotFoundException tnfe) { }
     }

     
return element;
}




ForumThreadBlockIterator是真正实现分页查询的核心功能,ForumThreadBlockIterator对象返回到客户端的过程中,遭遇ForumThreadIteratorProxy的截获,可以回头看看ForumProxy中的threads方法,它最终返回给调用客户端Forum.jsp的是ForumThreadIteratorProxy实例。

ForumThreadIteratorProxy也是迭代器ForumThreadIterator的一个子类,它的一个具体方法中:


public Object next() {

return new ForumThreadProxy((ForumThread)iterator.next(), authorization,
            permissions);
}


这一句是返回一个ForumThreadProxy实例,返回就是一个ForumThread实例的代理。这里,Jive使用代理模式实现访问控制实现得不是很巧妙,似乎有代理到处“飞”的感觉,这是可以对之进行改造的。

从以上可以看出,Jive在输出如图3-5所示的多页查询结果时,采取了下列步骤:

(1)先查询出符合查询条件的所有对象元素的ID集合,注意不是所有对象元素,只是其ID的集合,这样节约了大量内存
(2)每个页面视为一个Block,每当进入下一页时,获得下一个页面的所有对象的ID集合。
(3)输出当前页面的所有对象时,首先从缓冲中获取,如果缓冲中没有,再根据ID从数据库中获取完整的对象数据。

上述实现方法完全基于即查即显,相比于一般批量查询做法:一次性获得所有数据,然后遍历数据结果集ResultSet,Jive这种批量查询方式是一种比较理想的选择。

以上是ForumThread的批量显示,有关帖子内容ForumMessage也是采取类似做法。在每个ForumThread中可能有很多帖子内容(ForumMessage对象集合),也不能在一个页面中全部显示,所以也是使用迭代模式来实现的。显示一个Forum主题下所有帖子内容的功能由ForumThread的messages()方法完成,检查它的代理类FroumThreadProxy如何具体完成:

public Iterator messages(ResultFilter resultFilter) {
   Iterator iterator 
= thread.messages(resultFilter);
   
return new IteratorProxy(JiveGlobals.MESSAGE, iterator, authorization, permissions); 
}


实现的原理基本相同,返回的都是一个Iterator代理类,在这些代理类中都是进行用户权限检验的。

Jive中也有关于一次性获得所有数据,然后遍历ResultSet的做法。这种做法主要适合一次性查询数据库的所有数据,例如查询当前所有论坛Forum,首先实现SQL语句:

SELECT forumID FROM jiveForum

获得所有Forum的forumID,这段代码位于DbForumFactory.java的forums方法中,如下:


public Iterator forums() {
    
if (forums == null{
      LongList forumList 
= new LongList();
      Connection con 
= null;
      PreparedStatement pstmt 
= null;
      
try {
        con 
= ConnectionManager.getConnection();
        
// GET_FORUMS值是SELECT forumID FROM jiveForum
        pstmt = con.prepareStatement(GET_FORUMS);
        ResultSet rs 
= pstmt.executeQuery();
       
while (rs.next()) {
          forumList.add(rs.getLong(
1));                 //将所有查询ID结果放入forumList中
        }

      }
catch (SQLException sqle) {
        sqle.printStackTrace();
      }
 finally {
        …
    }

    
return new DatabaseObjectIterator(JiveGlobals.FORUM, forums, this);
}


forums方法是返回一个DatabaseObjectIterator,这个DatabaseObjectIterator也是一个迭代器,但是实现原理要比ForumThreadBlockIterator简单。它只提供了一个遍历指针,在所有ID结果集中遍历,然后也是通过ID获得完整的数据对象。

总之,Jive中关于批量查询有两种实现方式:以ForumThreadBlockIterator为代表的实现方式适合在数据量巨大、需要多页查询时使用;而DatabaseObjectIterator则是推荐在一个页面中显示少量数据时使用。