Servlet Config和Context入门

接下来学习一下ServletConfig和ServletContext的内容，简单来说ServletConfig是相对当前servlet的，ServletContext是相对整个web应用的，此外ServletContext还可以获得资源路径，下面简单整理一下。

Servlet Config

获取当前servlet对象的配置信息

Servlet Config代表当前servlet在web.xml中的配置信息对象，除了在web.xml中配置servlet的基本映射信息外，还可以配置一个或多个参数，参数和参数值可以通过Servlet config对象的api来获得，在servlet3.0中也可以在注解中配置参数，下面简单的看下。

ServletConfig对象通过getInitParameter方法可以获取参数值，通过getInitParameterNames来获取参数名。

（1）web.xml中配置参数，在servlet标签内，添加init-param标签，里面填写参数名和参数值即可。

    <!-- 填写servlet标签 -->
    <servlet>
        <servlet-name>SConfigDemo01</servlet-name>
        <servlet-class>com.boe.servletconfig.SConfigDemo01</servlet-class>
        <!--这里可以添加初始化参数-->
        <init-param>
            <param-name>name</param-name>
            <param-value>clyang</param-value>
        </init-param>
    </servlet>
    <servlet-mapping>
        <servlet-name>SConfigDemo01</servlet-name>
        <url-pattern>/SConfigDemo01</url-pattern>
    </servlet-mapping>

servlet代码测试获取参数，servlet启动时，init方法只会执行一次，将web.xml中的信息加载到config对象中。如果想多次获取config对象中的参数，可以将其设置为全局变量，这样每次访问都可以得到参数值，另外下面使用init方法获取config对象。

package com.boe.servletconfig;

import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

/**
 * 获取servletconfig参数
 */
//@WebServlet("/SConfigDemo01")
public class SConfigDemo01 extends HttpServlet {

    //设置全部变量，其他方法也可以使用config
    ServletConfig config;

    /**
     * servlet启动时，会加载web.xml信息到ServletConfig config对象，只在第一次访问时加载一次web.xml
     * @param config
     * @throws ServletException
     */
    @Override
    public void init(ServletConfig config) throws ServletException {
        //重写init方法
        //super.init(config);
        //获取web.xml中的参数，只能获取一次
        String parameter = config.getInitParameter("name");
        System.out.println("name="+parameter);
        //初始化方法中，将config初始化
        this.config=config;
    }

    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        //测试多次获取参数，OK
        String parameter = config.getInitParameter("name");
        System.out.println("name="+parameter);
    }

    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        doPost(request, response);
    }
}

多次访问后，可以重复得到结果。

（2） 在servlet3.0中也可以在注解中添加参数，即使用@WebServlet( initParams={@WebInitParam(name="参数名",value="参数值")})来添加，下面使用注解的方式测试获取参数，另外config对象可以使用this.getServletConfig方法获得，config对象本来就是给当前servlet服务的，通过它可以获取它身上的config对象。

package com.boe.servletconfig;

import javax.servlet.ServletConfig;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebInitParam;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.Enumeration;
//注解配置初始化参数的方式，使用initParams
@WebServlet(value="/SConfigDemo02",initParams = {@WebInitParam(name="name",value = "张飞")})
public class SConfigDemo02 extends HttpServlet {
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        //也可以直接使用它来获取config
        ServletConfig config = this.getServletConfig();
        //可以多次获取web.xml中的参数
        String name = config.getInitParameter("name");
        System.out.println("name="+name);
        //获取参数名
        Enumeration<String> parameterNames = config.getInitParameterNames();
        while(parameterNames.hasMoreElements()){
            String s = parameterNames.nextElement();
            System.out.println("初始化参数名为："+s);
        }

        //获取全局配置信息
        ServletContext context = config.getServletContext();
        String driver = context.getInitParameter("driver");
        System.out.println("driver="+driver);
    }

    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        doPost(request, response);
    }
}

测试结果，可以看到可以正常获取config，以及它身上的参数。另外还可以获取cofig中的参数名，getInitParameterNames方法返回的是一个枚举类型。

Servlet Context

ServletContext对象可以获取全局配置信息，可以作为域对象使用，还可以获取资源路径。

获取全局配置信息

ServletContext是针对整个web应用的，它的范围是最大的，当有些信息不仅仅只局限在单个servlet内使用时，就可以将信息配置到Servlet Context中，可以在web.xml中配置，如下所示。ServletContext对象是在web应用被加载时就会被创建保存在内存中供使用，直到web应用被移除出容器或者服务器关闭它才销毁。

    <!--配置全局信息，所有servlet都可以读取-->
    <context-param>
        <param-name>driver</param-name>
        <param-value>com.mysql.jdbc.Driver</param-value>
    </context-param>

测试servlet类，获取全局信息，有两个方法可以获取ServletContext对象，其中this.getServletContext方法底层就是调用this.getServletConfig().getServletContext()方法。

package com.boe.servletcontext;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.Enumeration;

/**
 * 获取全局配置信息
 */
@WebServlet("/SContextDemo01")
public class SContextDemo01 extends HttpServlet {
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        //获取servletContext对象 以下两种方法都可以
        //ServletContext context = this.getServletConfig().getServletContext();
        ServletContext context=this.getServletContext();

        //获取全局的配置信息
        String driver = context.getInitParameter("driver");
        System.out.println("driver="+driver);

        //获取参数名
        Enumeration<String> parameterNames = context.getInitParameterNames();
        while(parameterNames.hasMoreElements()){
            String name = parameterNames.nextElement();
            System.out.println("context的参数名为:"+name);
        }
    }

    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        doPost(request, response);
    }
}

测试结果，发现可以获取web.xml中的全局信息，另外也可以获取参数名，通过参数名可以遍历参数值。

域对象共享数据

与前面讲的ServletRequest类似，ServletContext对象也可以作为域对象使用，它也有一个可见的范围（整个web应用可见），并且通过map可以共享身上的数据，它提供的api跟其他域属性类似。下面在一个servlet中set一下域属性值，然后使用另外一个servlet获取域属性值，来测试是否可以在多个servlet之间共享数据。

保存域属性数据servlet

package com.boe.servletcontext;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

/**
 * 当前web应用，作为域对象使用
 */
@WebServlet("/SContextDemo02")
public class SContextDemo02 extends HttpServlet {
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        //1 获取servletContext对象
        ServletContext context = this.getServletContext();
        //2 通过它共享数据，设置域属性，demo03中去获取
        context.setAttribute("name","关羽");
    }

    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        doPost(request, response);
    }
}

获取域属性数据servlet

package com.boe.servletcontext;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

/**
 * 从servletcontext域中取出域属性
 */
@WebServlet("/SContextDemo03")
public class SContextDemo03 extends HttpServlet {
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        //创建servletcontext对象
        ServletContext context = this.getServletContext();
        //获取域属性
        String name = (String) context.getAttribute("name");
        System.out.println("获取域属性name="+name);
    }

    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        doPost(request, response);
    }
}

测试先访问第一个servlet，然后访问第二个servlet，查看控制台是否输出，发现可以正常输出域属性。

获取资源路径

ServletContext可以用在获取资源路径名，这样可以实现动态获取路径名的效果，就算项目路径改了依然可以获取到想要的资源路径，参考如下代码，通过若干种方式尝试获取放置在工程src目录下的conf.properties文件目录。

package com.boe.servletcontext;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.IOException;

/**
 * servletContext获取资源路径
 */
@WebServlet("/SContextDemo04")
public class SContextDemo04 extends HttpServlet {
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        //相对路径
        /*String path="conf.properties";
        File file=new File(path);
        String absolutePath = file.getAbsolutePath();
        //这种使用相对路径获取文件，再获取绝对路径的方式不对
        System.out.println("路径为："+absolutePath);//路径为：D:softwareapache-tomcat-7.0.62inconf.properties*/

        //绝对路径
        /*String path="/conf.properties";
        File file=new File(path);
        String absolutePath = file.getAbsolutePath();
        //这种使用绝对路径获取文件，再获取绝对路径的方式不对
        System.out.println("路径为："+absolutePath);//路径为：D:conf.properties*/

        //静态全路径
        /*String path="D:\software\apache-tomcat-7.0.62\webapps\day11-servletConfigContext\WEB-INF\classes\conf.properties";
        File file=new File(path);
        String absolutePath = file.getAbsolutePath();
        //这种使用静态写死路径获取文件，再获取绝对路径的方式对，但是维护不方便
        System.out.println("路径为："+absolutePath);//路径为：D:conf.properties*/

        //使用servletContext
        /*ServletContext context = this.getServletContext();
        //这个方法会动态在前面拼接上web应用的根目录D:softwareapache-tomcat-7.0.62webappsday11-servletConfigContex
        String realPath = context.getRealPath("\WEB-INF\classes\conf.properties");
        File file=new File(realPath);
        String absolutePath = file.getAbsolutePath();
        //
        System.out.println("路径为："+absolutePath);*/

        //使用字节码文件获取路径
        String realPath = SContextDemo04.class.getClassLoader().getResource("conf.properties").getPath();
        File file=new File(realPath);
        String absolutePath = file.getAbsolutePath();
        //
        System.out.println("路径为："+absolutePath);


    }

    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        doPost(request, response);
    }
}

（1）使用相对路径，会去程序启动的目录下寻找这个资源，tomcat的启动脚本在bin目录下，因此这里获得的结果就是bin目录下的结果，是不对的。

 （2）使用绝对路径，会去程序启动目录的根目录下去寻找，这里tomcat在D盘，因此获得的结果就是D盘根目录下的结果，也是不对的。

 （3）使用静态全路径，即将真实文件目录作为路径传入File，再输出File的路径，这样的获取资源路径的结果是对的，但是如果我将项目部署到其他的地方，或者linux中，就不是从D盘开始了，这样就需要重新改路径名非常的不方便，不可取。

 （4）使用ServletContext的getRealPath方法，这方法会在传入参数路径前面动态拼接上web应用的根目录，即部署在webapp下的目录，因此就算更换了部署环境也可以动态获取到真实的路径，是推荐使用的方法。

 （5）使用class文件的类加载器，这个方法也可以获取到，因为获取的资源和当前类的相对路径是确定的，更换部署环境依然可以通过两者不变的相对路径来获取到对应资源，这里注意getResource里传入的文件路径必须是相对于类加载器加载类的路径 。

 实际位置：

以上是对ServletConfig和ServletContext的简单总结，后续拿来查看。