Tomcat 配置和spring

简介

Tomcat启动时，先找系统变量CATALINA_BASE，如果没有，则找CATALINA_HOME。然后找这个变量所指的目录下的conf文件夹，从中读取配置文件。最重要的配置文件：server.xml 。要配置tomcat，基本上了解server.xml，context.xml和web.xml。

Server.xml --  tomcat主配置文件

Web.xml -- servlet与其他适用于整个Web应用程序设置的配置文件，必须符合servlet规范的标准格式。

Context.xml -- 默认的context配置，应用于安装了Tomcat的所有主机的所有部署内容。该文件的格式和标准的context XML片段文件的格式完全相同。它应包含在context元素中，而且暗含元素应嵌套与Context中。即该文件中的配置是所有web.xml的全局配置。

applicationContext.xml -- 默认的spring框架全局配置信息

{servlet-name}-servlet.xml -- Spring MVC 的Servlet的核心配置文件 

Server.xml

配置元素说明：

元素名	属性	解释
server	port	指定一个端口，这个端口负责监听关闭tomcat 的请求
shutdown	指定向端口发送的命令字符串
service	name	指定service 的名字
Connector ( 表示客户端和service之间的连接)	port	指定服务器端要创建的端口号，并在这个断口监听来自客户端的请求
minProcessors	服务器启动时创建的处理请求的线程数
maxProcessors	最大可以创建的处理请求的线程数
enableLookups	如果为true ，则可以通过调用request.getRemoteHost()进行DNS 查询来得到远程客户端的实际主机名，若为false则不进行DNS 查询，而是返回其ip 地址
redirectPort	指定服务器正在处理http 请求时收到了一个SSL 传输请求后重定向的端口号
acceptCount	指定当所有可以使用的处理请求的线程数都被使用时，可以放到处理队列中的请求数，超过这个数的请求将不予处理
connectionTimeout	指定超时的时间数( 以毫秒为单位)
Engine ( 表示指定service 中的请求处理机，接收和处理来自Connector 的请求)	defaultHost	指定缺省的处理请求的主机名，它至少与其中的一个host元素的name 属性值是一样的
Context ( 表示一个web 应用程序，通常为WAR 文件，关于WAR 的具体信息见servlet 规范)	docBase	应用程序的路径或者是WAR 文件存放的路径
path	表示此web 应用程序的url 的前缀，这样请求的url为http://localhost:8080/path/ ****
reloadable	这个属性非常重要，如果为true ，则tomcat 会自动检测应用程序的/WEB-INF/lib 和/WEB-INF/classes 目录的变化，自动装载新的应用程序，我们可以在不重起tomcat 的情况下改变应用程序
host ( 表示一个虚拟主机 )	name	指定主机名
appBase	应用程序基本目录，即存放应用程序的目录
unpackWARs	如果为true ，则tomcat 会自动将WAR 文件解压，否则不解压，直接从WAR 文件中运行应用程序
Logger ( 表示日志，调试和错误信息)	className	指定logger 使用的类名，此类必须实现org.apache.catalina.Logger 接口
prefix	指定log 文件的前缀
suffix	指定log 文件的后缀
timestamp	如果为true ，则log 文件名中要加入时间，如下例:localhost_log.2001-10-04.txt
Realm ( 表示存放用户名，密码及role 的数据库)	className	指定Realm 使用的类名，此类必须实现org.apache.catalina.Realm 接口
Valve ( 功能与Logger 差不多，其prefix和suffix 属性解释和Logger 中的一样)	className	指定Valve 使用的类名，如用org.apache.catalina.valves.AccessLogValve 类可以记录应用程序的访问信息
directory	指定log 文件存放的位置
pattern	有两个值，common 方式记录远程主机名或ip 地址，用户名，日期，第一行请求的字符串，HTTP 响应代码，发送的字节数。combined 方式比common 方式记录的值更多

<Server>元素

代表整个容器，是Tomcat实例的顶层元素.由org.apache.catalina.Server接口来定义。它包含一个<Service>元素，并且它不能做为任何元素的子元素。

示例：

 < Server port ="8005" shutdown ="SHUTDOWN" debug ="0" >

属性：

1. className指定实现org.apache.catalina.Server接口的类.默认值为

org.apache.catalina.core.StandardServer

2. port指定Tomcat监听shutdown命令端口.终止服务器运行时，必须在Tomcat服务器所在的机器上发出shutdown命令.该属性是必须的。

3. shutdown指定终止Tomcat服务器运行时，发给Tomcat服务器的shutdown监听端口的字符串。该属性必须设置。

<Service>元素

由org.apache.catalina.Service接口定义，它包含一个<Engine>元素，以及一个或多个

<Connector>，这些Connector元素共享用同一个Engine元素

示例：

< Service name ="Catalina" > 

< Service name ="Apache" >

   第一个<Service>处理所有直接由Tomcat服务器接收的web客户请求.

   第二个<Service>处理所有由Apahce服务器转发过来的Web客户请求

属性：

1. className 指定实现org.apahce.catalina.Service接口的类.默认为

org.apahce.catalina.core.StandardService

2. name定义Service的名字

<Engine>元素

每个Service元素只能有一个Engine元素，处理在同一个<Service>中所有<Connector>元素接收到的客户请求。由org.apahce.catalina.Engine接口定义。<Engine>可包含如下元素<Logger>， <Realm>， <Value>， <Host>

示例：

< Engine name ="Catalina" defaultHost ="localhost" debug ="0" >

说明：

1. className指定实现Engine接口的类，默认值为StandardEngine

2. defaultHost指定处理客户的默认主机名，在<Engine>中的<Host>子元素中必须定义这一主机

3. name定义Engine的名字

<Host>元素

由Host接口定义。一个Engine元素可以包含多个<Host>元素。每个<Host>的元素定义了一个虚拟主机，包含了一个或多个Web应用。<Host>元素中可包含如下子元素<Logger>， <Realm>， <Value>， <Context>

示例：

< Host name ="localhost" debug ="0" appBase ="webapps" unpackWARs ="true" autoDeploy ="true" >

属性：

1. className指定实现Host接口的类.默认值为StandardHost

2. appBase指定虚拟主机的目录，可指定绝对目录，也可指定相对于<CATALINA_HOME>的相对目录。如果没有此项，默认为<CATALINA_HOME>/webapps

3. autoDeploy如果此项设为true，表示Tomcat服务处于运行状态时，能够监测appBase下的文件，如果有新有web应用加入进来，会自运发布这个WEB应用

4. unpackWARs如果此项设置为true，表示把WEB应用的WAR文件先展开为开放目录结构后再运行。如果设为false将直接运行为WAR文件

5. alias指定主机别名，可以指定多个别名

6. deployOnStartup如果此项设为true，表示Tomcat服务器启动时会自动发布appBase目录下所有的Web应用。如果Web应用中的server.xml没有相应的<Context>元素，将采用Tomcat默认的Context

7. name定义虚拟主机的名字

<Context>元素

由Context接口定义。是使用最频繁的元素。每个<Context>元素代表了运行在虚拟主机上的单个Web应用。一个<Host>可以包含多个<Context>元素。每个web应用有唯一的一个相对应的Context代表web应用自身。 servlet容器为第一个web应用创建一个ServletContext对象。<Context>元素可包含如下元素<Logger>， <Realm>， <Resource>， <ResourceParams>

示例：

< Context path ="/sample" docBase ="sample" debug ="0" reloadbale ="true" >

属性：

1. className指定实现Context的类，默认为StandardContext类

2. path指定访问Web应用的URL入口，注意/myweb，而不是myweb

3. reloadable如果这个属性设为true， Tomcat服务器在运行状态下会监视在WEB-INF/classes和Web-INF/lib目录CLASS文件的修改，如果监视到有class文件被更新，服务器自重新加载Web应用

4. cookies指定是否通过Cookies来支持Session，默认值为true

5. useNaming指定是否支持JNDI，默认值为了true

<Connector>元素

由Connector接口定义。<Connector>元素代表与客户程序实际交互的给件，它负责接收客户请求，以及向客户返回响应结果.

示例：

 < Connector port ="8080" maxThread ="50" minSpareThreads ="25" maxSpareThread ="75" 

 enableLookups ="false" redirectPort ="8443" acceptCount ="100" debug ="0" 

 connectionTimeout ="20000" disableUploadTimeout ="true" /> 

 < Connection port ="8009" enableLookups ="false" redirectPort ="8443" debug ="0" 

 protocol ="AJP/1.3" />

第一个Connector元素定义了一个HTTP Connector，它通过8080端口接收HTTP请求;第二个Connector元素定义了一个JD Connector，它通过8009端口接收由其它服务器转发过来的请求.

Connector元素共用属性：

1. className指定实现Connector接口的类

2. enableLookups如果设为true，表示支持域名解析，可以把IP地址解析为主机名.WEB应用中调用request.getRemoteHost方法返回客户机主机名.默认值为true

3. redirectPort指定转发端口.如果当前端口只支持non-SSL请求，在需要安全通信的场命，将把客户请求转发至SSL的redirectPort端口

HttpConnector元素的属性

1. className实现Connector的类

2. port设定Tcp/IP端口，默认值为8080，如果把8080改成80，则只要输入http://localhost 即可，因为TCP/IP的默认端口是80

3. address如果服务器有二个以上ip地址，此属性可以设定端口监听的ip地址.默认情况下，端口会监听服务器上所有的ip地址

4. bufferSize设定由端口创建的输入流的缓存大小.默认值为2048byte

5. protocol设定Http协议，默认值为HTTP/1.1

6. maxThreads设定在监听端口的线程的最大数目，这个值也决定了服务器可以同时响应客户请求的最大数

目.默认值为200

7. acceptCount设定在监听端口队列的最大客户请求数量，默认值为10.如果队列已满，客户必须等待.

8. connectionTimeout定义建立客户连接超时的时间.如果为-1，表示不限制建立客户连接的时间

JkConnector的属性

1. className实现Connector的类

2. port设定AJP端口号

3. protocol必须设定为AJP/1.3

web.xml

Web.xml -- servlet与其他适用于整个Web应用程序设置的配置文件，必须符合servlet规范的标准格式。在Tomcat中，有两处会用到web.xml: 1) CATALINA_BASE/conf目录; 2) 每个Web应用程序的./WEB-INF。这两个文件共同定义Web应该程序的行为。其中CATALINA_BASE/conf/web.xml 是全局配置，适用于所有的Web应用程序。应用程序的./WEB-INF/web.xml 是针对各个Web应该程序的独立配置，只对单个Web Context有效。一般CATALINA_BASE/conf/web.xml 不需修改，采用Tomcat默认配置即可。

/WEB-INF/web.xml常见配置项

context-param -- 应用于整个Web应用程序(Context)的初始化参数。有多项，则分开。

filter / filter-mapping -- 共同配置Context的过滤规则。filter 配置过滤器；filter-mapping配置过滤规则和过滤器的映射关系。

Listener -- 配置整个Web的事件触发器。

Servlet / servlet-mapping -- 配置servlet和servlet所处理的HTTP请求(servlet-mapping)

session-config -- 配置HTTP session相关属性。

welcome-file-list -- 配置欢迎页。

示例：启用 Spring 容器和 Spring MVC 框架

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" version="2.5">

    <!--  Spring 服务层的配置文件 -->
    <context-param>
        <param-name>log4jConfigLocation</param-name>
        <param-value>/WEB-INF/classes/log4j.properties</param-value>
    </context-param>
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/classes/application*.xml</param-value>
    </context-param>

    <filter>
        <filter-name>CharacterFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>utf-8</param-value>
        </init-param>
        <init-param>
            <param-name>force</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>

    <filter-mapping>
        <filter-name>CharacterFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

      <!--  Spring 容器启动监听器 -->
　　<listener>             
　　<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
　　
　　<!--  Spring MVC 的Servlet，它将加载WEB-INF/testserver-servlet.xml 的
　　    配置文件，以启动Spring MVC模块-->
    <servlet>
        <servlet-name>testserver</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>testserver</servlet-name>
        <url-pattern>*.do</url-pattern>
　　</servlet-mapping>
　　
    <session-config>
        <!-- Default to 5 minute session timeouts -->
        <session-timeout>10</session-timeout>
    </session-config>
    <welcome-file-list>
        <welcome-file>/welcome.jsp</welcome-file>
    </welcome-file-list>
</web-app>

Web应用程序布局和部署

应用程序布局目录规范

./webapps/

./webapps/ROOT

./webapps/ROOT/index.html

./webapps/di

./webapps/di/META-INF

./webapps/di/META-INF/MANIFEST.MF

./webapps/di/WEB-INF

./webapps/di/WEB-INF/lib

./webapps/di/WEB-INF/di-servlet.xml

./webapps/di/WEB-INF/applicationContext.xml

./webapps/di/WEB-INF/classes

./webapps/di/WEB-INF/web.xml

其中，web.xml是核心配置文件。

部署

解包目录的Web部署方式

服务提供者可将相应的class和lib放在相应目录下。优点：易于诊断故障；支持单jar、class文件更新。缺点：不好监控文件变更。

WAR文件部署方式

Java servlet规范支持将整个Web目录下的所有文件(配置、class、jar等)打包成WAR文件，以单个WAR文件方式部署Web应用程序。优点：容易监控WAR文件变更，有利于安全防护(防黑客攻击)。

Spring MVC配置

org.springframework.web.context.ContextLoaderListener

ContextLoaderListener的作用就是启动Web容器时，自动装配ApplicationContext的配置信息。因为它实现了ServletContextListener这个接口，在web.xml配置这个监听器，启动容器时，就会默认执行它实现的方法。

ApplicationContext.xml这个配置文件部署: 如果在web.xml中不写任何参数配置信息，默认的路径是”/WEB-INF/applicationContext.xml，在WEB-INF目录下创建的xml文件的名称必须是applicationContext.xml。如果是要自定义文件名可在web.xml里加入contextConfigLocation这个context参数：

<context-param> 

<param-name>contextConfigLocation</param-name> 

<param-value> 

 /WEB-INF/classes/applicationContext-*.xml 

</param-value> 

</context-param>

在<param-value> </param-value>里指定相应的xml文件名；如果有多个xml文件，可写在一起并一“,”号分隔。上面的applicationContext-*.xml采用通配符，比如这那个目录下有applicationContext-ibatis-base.xml，applicationContext-action.xml，applicationContext-ibatis-dao.xml等文件，都会一同被载入。

由此可见applicationContext.xml的文件位置就可以有两种默认实现：

第一种：直接将之放到/WEB-INF下，并在web.xml中声明一个listener。

第二种：放到classpath下，且需在web.xml中加入<context-param>，用它来指明你的applicationContext.xml的位置以供web容器来加载。按照 Struts2 整合spring的官方给出的档案，写成：

<!-- Context Configuration locations for Spring XML files --> 

<context-param> 

<param-name>contextConfigLocation</param-name> 

<param-value>/WEB-INF/applicationContext-*.xml,classpath:applicationContext-*.xml</param-value> 

</context-param>

*-servlet.xml 示例(可使用ContextLoaderListener载入的配置)

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd">
<beans>

        <bean id="propertyPlaceholderConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
                <property name="locations">
                        <list>
                                <value>/WEB-INF/classes/test.properties</value>
                        </list>
                </property>
        </bean>

        <bean id="handlerMapping" class="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping">
                <property name="mappings">
                        <props>
                                <prop key="/gettest.do">getTestController</prop>
                        </props>
                </property>
        </bean>

        <bean name="getTestController" class="com.test.service.diserviceDo" singleton="false">
                <property name="onlineIndex" ref="diIndex" />
                <property name="yearIndex" ref="yearIndex" />
        </bean>

        <bean id="diIndex" class="com.di.service.MulSearch" singleton="true">
                <constructor-arg value="${di.dir}" />
                <constructor-arg value="${di.num}" />
        </bean>

        <bean id="yearIndex" class="com.di.service.MulSearch" singleton="true">
                <constructor-arg value="${year.dir}" />
                <constructor-arg value="${year.num}" />
        </bean>
</beans>

参考文章

Tomcat权威指南 - 第三章、第七章

tomcat配置文件server.xml详解

使用 Spring 基于注解驱动的 Spring MVC