Solr源码结构

1. 目录结构说明

我们下载的Solr包中，进入Solr所在的目录，我们可以看到以下几个目录：build、client、dist、example、lib、site、src。下面分别对其进行介绍。

1.1. build

该目录是在ant build过程中生成的，其中包含了未被打包成jar或是war的class文件以及一些文档文件。

1..2. client

该目录包含了特定语言的Solr客户端API，使得使用其他语言的用户能通过HTTP用XML与Solr进行通话。现在该目录里面虽然包含JavaScript、Python、ruby三个子目录，但是到目前为止只包含一部分的ruby的代码，其他语言仍是空的。另外，Solr的Java客户端称为SolrJ，其代码位于src/solrj目录下面。

1.3. dist

该目录包含build过程中产生的war和jar文件，以及相关的依赖文件。需要部署时，其实就是将该目录下面的apache-solr-1.4.war部署到Jetty上面去，并重命名为solr.war。

1.4. example

这个目录实际上是Jetty的安装目录。其中包含了一些样例数据和一些Solr的配置。
其中一些子目录也比较重要，这里也对它们稍作介绍。
　 example/etc：该目录包含了Jetty的配置，在这里我们可以将Jetty的默认端口从8983改为80端口。
　 将其中的8983端口换成80端口。注意更改端口后启动Jetty可能会提示你没有权限，你需要使用sudo java -jar start.jar来运行。
　 example/multicore：该目录包含了在Solr的multicore中设置的多个home目录。在之后的文章中我会对其进行介绍。
　 example/solr：该目录是一个包含了默认配置信息的Solr的home目录。
详见下面的“solr home说明”
　example/webapps：Jetty的webapps目录，该目录通常用来放置Java的Web应用程序。在Solr中，前面提到的solr.war文件就部署在这里。

1.5. lib

该目录包含了所有Solr的API所依赖的库文件。其中包括Lucene，Apache commons utilities和用来处理XML的Stax库。

1.6. site

该目录仅仅包含了Solr的官网的网页内容，以及一些教程的PDF文档。

1.7. src

该目录包含了Solr项目的整个源代码。这里对其各个子目录也做相应的介绍。
　src/java：该目录存放的是Solr使用Java编写的源代码。
　src/scripts：该目录存放的是配置Solr服务器的Unix Bash Shell脚本，在后面介绍多服务器配置中将会有重要的作用。
　src/solrj：前面提到过该目录存放的是Solr的Java版本的客户端代码。
　src/test：该目录存放的是测试程序的源代码和测试文件。
　src/webapp：该目录存放的是管理Solr的Web页面，包括Servlet和JSP文件，其构成了前面提到的WAR文件。管理Solr的JSP页面在web/admin目录下面，如果你有兴趣折腾Solr可以找到相应的JSP的页面对其进行设置

 

2. Solr home说明

2.1. 什么是Solr home

所谓的Solr home目录实际上是一个运行的Solr实例所对应的配置和数据（Lucene索引）。
在Solr的example/solr目录就是一个Solr用做示例的默认配置home目录。
实际上example/multicore也是一个合法的Solr home目录，只不过是用来做mult-core设置的。

 

2.2. Solr home中都有什么？

我们来看看example/solr这个目录里面都有些什么。

example/solr目录下主要有以下一些目录和文件：
1) bin：如果你需要对Solr进行更高级的配置，该目录建议用来存放Solr的复制脚本。
2) conf ：该目录下面包含了各种配置文件，下面列出了两个最为重要的配置文件。其余的.txt和.xml文件被这两个文件所引用，如用来对文本进行特殊的处理。
　conf/schema.xml：该文件是索引的schema，包含了域类型的定义以及相关联的analyzer链。
　conf/solrconfig.xml：该文件是Solr的主配置文件。
　conf/xslt：该目录包含了各种XSLT文件，能将Solr的查询响应转换成不同的格式，如：Atom/RSS等。
3) data：包含了Lucene的二进制索引文件。
4) lib：该目录是可选的。用来放置附加的Java JAR文件，Solr在启动时会自动加载该目录下的JAR文件。这就使得用户可以对Solr的发布版本（solr.war）进行扩展。如果你的扩展并不对Solr本身进行修改，那么就可以将你的修改部署到JAR文件中放到这里。

 

2.3. Solr是如何找到运行所需要的home目录的呢？

Solr首先检查名为solr.solr.home的Java系统属性，有几种不同的方式来设置该Java系统属性。

一种不管你使用什么样的Java应用服务器或Servlet引擎都通用的方法是在调用Java的命令行中进行设置。
所以，你可以在启动Jetty的时候显式地指定Solr的home目录java -Dsolr.solr.home=solr/ -jar start.jar。

另一种通用的方法是使用JNDI，将home目录绑定到java:comp/env/solr/home。
并向src/webapp/web/WEB-INF/web.xml添加以下一段代码：
 <env-entry>
   <env-entry-name>solr/home</env-entry-name>
   <env-entry-value>solr/</env-entry-value>
   <env-entry-type>java.lang.String</env-entry-type>
 </env-entry>
实际上这段XML在web.xml文件中已经存在，你只需要把原来注释掉的xml取消注释，添加你所要指向的home目录即可。
因为修改了web.xml文件，所以你需要运行ant dist-war来重新打包之后再部署WAR文件。

最后，如果Solr的home目录既没有通过Java系统属性指定也没有通过JNDI指定，那么他将默认指向solr/。

在产品环境中，我们必须设置Solr的home目录而不是让其默认指向solr/。
而且应该使用绝对路径，而不是相对路径，因为你有可能从不同的目录下面启动应用服务器。

 

2.4. Jetty是什么

注：Jetty 是一个开源的servlet容器，它为基于Java的web内容，例如JSP和servlet提供运行环境。
Jetty是使用Java语言编写的，它的API以一组JAR包的形式发布。
开发人员可以将Jetty容器实例化成一个对象，可以迅速为一些独立运行（stand-alone）的Java应用提供网络和web连接。

 

 

3. Solr的包说明

3.1. Solr的12个包

 

Apache Solr的各个包，力图详细地分析Solr的设计和架构。Apache Solr由12个包组成，如下：
org.apache.solr.analysis
org.apache.solr.core
org.apache.solr.request
org.apache.solr.schema
org.apache.solr.search
org.apache.solr.search.function
org.apache.solr.servlet
org.apache.solr.tst
org.apache.solr.update
org.apache.solr.util
org.apache.solr.util.test
org.apache.solr.util.xlst

3.2. Solr的servlet包

 

我们先从使用者的角度出发，最先看到的当然是servlet,因为Solr本身是个独立的网络应用程序，需要在Servlet容器中运行来提供服务，所以servlet是用户接触的最外层。

我们看看org.apache.solr.servlet包。这个包很简单，只有两个类：SolrServlet和SolrUpdateServlet.我们很容易从类名中猜出这两个类的用途。

SolrServlet类继承HttpServlet类，只有四个方法：
　init()
　destroy()
　doGet()
　doPost()

SolrServlet类中除了普通的Java类对象（包括Servlet相关的）外，有四个Solr本身的类，还有一个Solr本身的异常。
其中两个类和一个异常属于org.apache.solr.core包，两个类属于org.apache.solr.request包。

属于core包的有：
　Config:
　SolrCore:
属于request包的有：
　SolrQueryResponse:
　QueryResponseWriter:

 

3.3. 分析SolrServlet类

3.3.1. 首先servlet会调用init()方法进行初始化

　　通过Context查找java:comp/env/solr/home来确定Solr的主目录（home），接着调用Config.setInstanceDir(home)方法设置这个实例的目录。然后通过SolrCore.getSolrCore()来获得一个SolrCore实例。destroy()方法将会在Servlet对象销毁时调用，仅仅调用core.close()关闭SolrCore实例。

　　当用户请求进来时doPost()简单地将任务交给doGet()完成，主要的任务由doGet()完成。

 

3.3.2. 分析doGet()方法

1) 使用SolrCore和doGet()参数request生成一个SolrServletRequest对象(注意：这个SolrServletRequest类不是公开类，位于org.apache.solr.servlet包中，继承了SolrQueryRequestBase类，仅仅接受SolrCore和HttpServletRequest对象作为参数)

2) 然后SolrCore执行execute()方法（参数为SolrServletRequest和SolrQueryResponse）
由此可见，真正的处理核心是SolrCore的execute方法