搜索引擎Nutch源代码研究之一 网页抓取（1）

搜索引擎Nutch源代码研究之一 网页抓取：
Nutch的爬虫代码部分主要集中在：package org.apache.nutch.fetcher和插件protocol-file
Protocol-ftp protocol-http protocol-httpclient以及相应的Parser插件中：
下面我们先从org.apache.nutch.fetcher开始：
最主要的类是Fetcher类，我们从它入手一步步跟踪整个代码：
我们从run函数入手：
首先：

Java代码

1. for (int i = 0; i < threadCount; i++) {       // spawn threads   
2.       FetcherThread thread = new FetcherThread(THREAD_GROUP_NAME+i);    
3.       thread.start();   
4. }  

for (int i = 0; i < threadCount; i++) {       // spawn threads
      FetcherThread thread = new FetcherThread(THREAD_GROUP_NAME+i); 
      thread.start();
}

建立了多个FetcherThread线程来抓取网页，threadCount可以配置或者使用默认值。
接着一个while(true)的循环里面的代码：

Java代码

1. int n = group.activeCount();   
2.      Thread[] list = new Thread[n];   
3.      group.enumerate(list);   
4.      boolean noMoreFetcherThread = true; // assumption   
5.      for (int i = 0; i < n; i++) {   
6.        // this thread may have gone away in the meantime   
7.        if (list[i] == null) continue;   
8.        String tname = list[i].getName();   
9.        if (tname.startsWith(THREAD_GROUP_NAME)) // prove it   
10.          noMoreFetcherThread = false;   
11.        if (LOG.isLoggable(Level.FINE))   
12.          LOG.fine(list[i].toString());   
13.      }   
14.      if (noMoreFetcherThread) {   
15.        if (LOG.isLoggable(Level.FINE))   
16.          LOG.fine("number of active threads: "+n);   
17.        if (pages == pages0 && errors == errors0 && bytes == bytes0)   
18.          break;   
19.        status();   
20.        pages0 = pages; errors0 = errors; bytes0 = bytes;   
21.      }  

 int n = group.activeCount();
      Thread[] list = new Thread[n];
      group.enumerate(list);
      boolean noMoreFetcherThread = true; // assumption
      for (int i = 0; i < n; i++) {
        // this thread may have gone away in the meantime
        if (list[i] == null) continue;
        String tname = list[i].getName();
        if (tname.startsWith(THREAD_GROUP_NAME)) // prove it
          noMoreFetcherThread = false;
        if (LOG.isLoggable(Level.FINE))
          LOG.fine(list[i].toString());
      }
      if (noMoreFetcherThread) {
        if (LOG.isLoggable(Level.FINE))
          LOG.fine("number of active threads: "+n);
        if (pages == pages0 && errors == errors0 && bytes == bytes0)
          break;
        status();
        pages0 = pages; errors0 = errors; bytes0 = bytes;
      }

相当于维护一个线程池，并在Log中输入抓取页面的速度，状态之类的信息。其实可以使用java.util.concurrent包的Executors来创建一个线程池来使用。
现在我们看看抓取的线程FetcherThread是如何工作的：
线程当然要从run方法来跟踪了：
FetchListEntry fle = new FetchListEntry();
建立一个抓取列表类，为了不分散精力，我们稍候在看看这个FetchListEntry以及相关类的数据结构。
然后又是一个while (true)的循环，我们看看里面做了些什么：

Java代码

1. if (fetchList.next(fle) == null)   
2.             break;   
3. url = fle.getPage().getURL().toString();   
4. 从当前的FetchListEntry中获得一个要抓取的url，然后   
5. if (!fle.getFetch()) {                  // should we fetch this page?   
6.             if (LOG.isLoggable(Level.FINE))   
7.                 LOG.fine("not fetching " + url);   
8.             handleFetch(fle, new ProtocolOutput(null, ProtocolStatus.STATUS_NOTFETCHING));   
9.             continue;   
10. }  

if (fetchList.next(fle) == null)
            break;
url = fle.getPage().getURL().toString();
从当前的FetchListEntry中获得一个要抓取的url，然后
if (!fle.getFetch()) {                  // should we fetch this page?
            if (LOG.isLoggable(Level.FINE))
                LOG.fine("not fetching " + url);
            handleFetch(fle, new ProtocolOutput(null, ProtocolStatus.STATUS_NOTFETCHING));
            continue;
}

如果不需要抓取，在handleFetch进行相应的处理。
然后又是一个do…while循环，用来处理抓取过程中重定向指定的次数：
整个循环的条件 refetch && (redirCnt < MAX_REDIRECT)
重新抓取并且重定向次数没有超出最大次数
ProtocolFactory工厂创建protocol实例：
Protocol protocol = ProtocolFactory.getProtocol(url);
Protocol的实现是以插件的形式提供的，我们先跳过Protocol实现的细节：
可以从protocol中获取到Fetch的输出流：
            ProtocolOutput output = protocol.getProtocolOutput(fle);
通过输出流可以获取到抓取的状态ProtocolStatus和抓取的内容Content：

Java代码

1. ProtocolStatus pstat = output.getStatus();   
2. Content content = output.getContent();  

ProtocolStatus pstat = output.getStatus();
Content content = output.getContent();

然后根据抓取的状态：
switch(pstat.getCode())
如果成功 case ProtocolStatus.SUCCESS:
如果内容不为空if (content != null)
修改抓取的页数，抓取的字节数，并且如果抓取了100页，根据pages,bytes在日志中记录抓取的速度等信息。

Java代码

1. synchronized (Fetcher.this) {           // update status   
2.                     pages++;   
3.                     bytes += content.getContent().length;   
4.                     if ((pages % 100) == 0) {             // show status every    
5.                       status();   
6.                     }   
7. }  

synchronized (Fetcher.this) {           // update status
                    pages++;
                    bytes += content.getContent().length;
                    if ((pages % 100) == 0) {             // show status every 
                      status();
                    }
}

在handleFetch进行相应的处理
ParseStatus ps = handleFetch(fle, output);
如果处理返回的状态不为空，并且成功的重定向：
if (ps != null && ps.getMinorCode() == ParseStatus.SUCCESS_REDIRECT)
获取重定向的链接并进行过滤：

Java代码

1. String newurl = ps.getMessage();   
2. newurl = URLFilters.filter(newurl);  

String newurl = ps.getMessage();
newurl = URLFilters.filter(newurl);

如果重定向的链接newurl不为空并且和现在的url不同：
if (newurl != null && !newurl.equals(url))
重新获取，更新refetch、url、redirCnt++;

Java代码

1. refetch = true;   
2. url = newurl;   
3. redirCnt++;  

      refetch = true;
      url = newurl;
      redirCnt++;

创建当前页面的FetchListEntry：
fle = new FetchListEntry(true, new Page(url, NEW_INJECTED_PAGE_SCORE), new String[0]);
如果链接页面已经转移或者临时转移：
case ProtocolStatus.MOVED: // try to redirect immediately
              case ProtocolStatus.TEMP_MOVED: // try to redirect immediately
立即重定向：
处理抓取的结果：
handleFetch(fle, output);
获取重定向的url:

Java代码

1.  String newurl = pstat.getMessage();   
2.      newurl = URLFilters.filter(newurl);   
3.      if (newurl != null && !newurl.equals(url)) {   
4.              refetch = true;       
5.              url = newurl;   
6.              redirCnt++;   
7.                   // create new entry.   
8.              fle = new FetchListEntry(true, new Page(url, NEW_INJECTED_PAGE_SCORE), new String[0]);   
9. }  

 String newurl = pstat.getMessage();
     newurl = URLFilters.filter(newurl);
     if (newurl != null && !newurl.equals(url)) {
             refetch = true;	
             url = newurl;
             redirCnt++;
                  // create new entry.
             fle = new FetchListEntry(true, new Page(url, NEW_INJECTED_PAGE_SCORE), new String[0]);
}

过程和上面的重定向类似。
以下几种状态：

Java代码

1. case ProtocolStatus.GONE:   
2. case ProtocolStatus.NOTFOUND:   
3. case ProtocolStatus.ACCESS_DENIED:   
4.  case ProtocolStatus.ROBOTS_DENIED:   
5.  case ProtocolStatus.RETRY:   
6.  case ProtocolStatus.NOTMODIFIED:  

case ProtocolStatus.GONE:
case ProtocolStatus.NOTFOUND:
case ProtocolStatus.ACCESS_DENIED:
 case ProtocolStatus.ROBOTS_DENIED:
 case ProtocolStatus.RETRY:
 case ProtocolStatus.NOTMODIFIED:

直接交由handleFetch(fle, output);来处理
如果发生异常，logger异常信息，然后交给handleFetch处理：
case ProtocolStatus.EXCEPTION:
          logError(url, fle, new Exception(pstat.getMessage()));               
          handleFetch(fle, output);
其他情况为未知状态，log出当前的状态，然后交给handleFetch处理
default:
         LOG.warning("Unknown ProtocolStatus: " + pstat.getCode());
         handleFetch(fle, output);
循环结束。
最后如果完成的线程数等于threadCount，关闭所有的插件：

Java代码

1. synchronized (Fetcher.this) {   
2.         atCompletion++;   
3.         if (atCompletion == threadCount) {   
4.           try {   
5.             PluginRepository.getInstance().finalize();   
6.           } catch (java.lang.Throwable t) {   
7.             // do nothing   
8.           }   
9.         }   
10.       }  

synchronized (Fetcher.this) {
        atCompletion++;
        if (atCompletion == threadCount) {
          try {
            PluginRepository.getInstance().finalize();
          } catch (java.lang.Throwable t) {
            // do nothing
          }
        }
      }

我们看到Fetch到页面后大多数的处理都交给了handleFetch了。
现在我们来看看private ParseStatus handleFetch(FetchListEntry fle, ProtocolOutput output) 的代码：
根据output获取到内容和url

Java代码

1. Content content = output.getContent();   
2. MD5Hash hash = null;   
3. String url = fle.getPage().getURL().toString();  

Content content = output.getContent();
MD5Hash hash = null;
String url = fle.getPage().getURL().toString();

如果content为null，我们直接空的content,然后对url 用digest编码,否则对content 用digest来编码：

Java代码

1. if (content == null) {   
2.         content = new Content(url, url, new byte[0], "", new Properties());   
3.         hash = MD5Hash.digest(url);   
4. } else {   
5.         hash = MD5Hash.digest(content.getContent());   
6. }  

if (content == null) {
        content = new Content(url, url, new byte[0], "", new Properties());
        hash = MD5Hash.digest(url);
} else {
        hash = MD5Hash.digest(content.getContent());
}

在获取ProtocolStatus
ProtocolStatus protocolStatus = output.getStatus();
如果Fetcher不进行解析（parse），直接把抓取的页面写入磁盘

Java代码

1. if (!Fetcher.this.parsing) {   
2.        outputPage(new FetcherOutput(fle, hash, protocolStatus),   
3.                content, null, null);   
4.        return null;   
5.      }  

 if (!Fetcher.this.parsing) {
        outputPage(new FetcherOutput(fle, hash, protocolStatus),
                content, null, null);
        return null;
      }

否则进行parse:
首先获取页面contentType，以便根据正确编码进行Parse的:
String contentType = content.getContentType();
下面便是使用Parser进行页面提取得过程：

Java代码

1. Parser parser = null;   
2.       Parse parse = null;   
3.       ParseStatus status = null;   
4.       try {   
5.         parser = ParserFactory.getParser(contentType, url);   
6.         parse = parser.getParse(content);   
7.         status = parse.getData().getStatus();   
8.       } catch (Exception e) {   
9.         e.printStackTrace();   
10.         status = new ParseStatus(e);   
11.       }  

Parser parser = null;
      Parse parse = null;
      ParseStatus status = null;
      try {
        parser = ParserFactory.getParser(contentType, url);
        parse = parser.getParse(content);
        status = parse.getData().getStatus();
      } catch (Exception e) {
        e.printStackTrace();
        status = new ParseStatus(e);
      }

如果提取页面成功：if (status.isSuccess())
将FetcherOutput提取的内容以及状态作为写入保存：

Java代码

1. outputPage(new FetcherOutput(fle, hash, protocolStatus),   
2.                content, new ParseText(parse.getText()), parse.getData());  

 outputPage(new FetcherOutput(fle, hash, protocolStatus),
                content, new ParseText(parse.getText()), parse.getData());

否则 else 将FetcherOutput和空的parse内容保存：

Java代码

1. LOG.info("fetch okay, but can't parse " + url + ", reason: "  
2.                 + status.toString());   
3.  outputPage(new FetcherOutput(fle, hash, protocolStatus),   
4.                 content, new ParseText(""),   
5.                 new ParseData(status, "", new Outlink[0], new Properties()));  

LOG.info("fetch okay, but can't parse " + url + ", reason: "
                + status.toString());
 outputPage(new FetcherOutput(fle, hash, protocolStatus),
                content, new ParseText(""),
                new ParseData(status, "", new Outlink[0], new Properties()));

我们先跳过Parser的过程。下次我们看看如何在http协议下载的web页面，这就Protocol
插件的实现。