141.Mybatis 与 JNDI

JNDI，全称 Java Naming and Directory Interface，Java 命名与目录接口，是 SUN 公司推出的一套规范，属于 JavaEE 技术之一，目的是模仿 Windows 系统中的注册表，提供一些资源给应用 ‍

使用 JNDI 之前

我们之前都是将数据库连接信息直接存放到配置文件中的，此时有一些问题存在：

1. 数据库连接信息是敏感的，直接写在代码里不合适，容易暴露 ；
2. 数据库服务器连接信息，可能会定期变化，导致得重新修改配置文件并重启；
3. .....

上述情况其实很常见。在笔者的公司里，开发人员是不能知道生产环境的数据库密码的！即使是运维人员，也是分开掌握一半的密码，当需要用到的时候才两人一起输入。

此外，为了安全期间，密码应该定期更换，降低暴力破解成功的可能性。

对于程序员来说，应该不需要关心具体 “数据库后台是什么？JDBC 驱动程序是什么？JDBC URL 格式是什么？访问数据库的用户名和口令是什么？”等等这些问题，程序员编写的程序应该没有对 JDBC 驱动程序的引用，没有服务器名称，没有用户名称或口令 —— 甚至没有数据库池或连接管理。而是把这些问题交给 J2EE 容器来配置和管理，程序员只需要对这些配置和管理进行引用即可。

为此，JNDI 技术出现了，JNDI 可以简单理解为一个字典、Map 容器，我们可以往里面存储一些信息，每个信息有自己的名字。

例如，我们可以在 JNDI 里存储数据源的信息，然后在 Java 程序里，使用 JNDI 来获取数据源，这样，就将数据源 和 应用程序 解耦了。数据源的连接信息，或者密码等信息修改，并不会影响应用程序的运行。不仅仅是 Tomcat，像一些商用的 Web 服务器，也是支持 JNDI 的，例如 WAS 和 WebLogic

环境准备

目前我们的项目有很多的代码，为了方便演示 JNDI，我们先切换分支到 demo1，也就是 Mybatis 的第一个案例中用到的代码；

然后，新增两个依赖：

<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>servlet-api</artifactId>
    <version>2.5</version>
    <scope>provided</scope>
</dependency>
<dependency>
    <groupId>javax.servlet.jsp</groupId>
    <artifactId>jsp-api</artifactId>
    <version>2.0</version>
    <scope>provided</scope>
</dependency>

新建一个 src/main/webapp 目录，用来存放 web 相关的文件

‍

新建 context.xml

我们在 web 目录下新建 META-INF 目录，然后在里面新建 context.xml 文件，内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<Context>
    <Resource
            name="jdbc/LearnMybatis"
            type="javax.sql.DataSource" 
            auth="Container"          
            maxActive="20"            
            maxWait="10000"           
            maxIdle="5"               
            username="LearnMybatisUser"
            password="LearnMybatisUserPassword"
            driverClassName="com.mysql.cj.jdbc.Driver"
            url="jdbc:mysql:///LearnMybatis"
    />
</Context>

‍ 属性说明：

• name：JDNI 资源的名称
• type：我们要存储什么样的资源，这里表示是数据源类型的资源。
• auth：数据源提供者，也就是容器，例如 Tomcat
• maxActive：最大活动数
• maxWait：最大等待时间，单位为秒
• maxIdle：最大空闲数
• 剩下四个就是数据库连接信息

这里我们还是新建了一个配置文件，存放了数据库密码；但一般来说，该文件是在 Tomcat 的配置文件里设置的，例如 Tomcat 自己也有 context.xml：apache-tomcat-9.0.73\conf\context.xml。我们为了方便直接在项目里创建了 context.xml。

在一些 web 服务器中，例如 WebShare，Weblogic，都是有可视化界面配置数据源的。

修改 Mybatis 配置文件

我们修改 Mybatis 的主配置文件：关键部分在第 4 ~ 第 6 行

<environments default="mysql">
    <environment id="mysql">
        <transactionManager type="JDBC"/>
        <dataSource type="JNDI">
            <property name="data_source" value="java:comp/env/jdbc/LearnMybatis"/>
        </dataSource>
    </environment>
</environments>

‍ value 属性中，前面的写法是固定的，不能修改的 java:comp/env/ ‍

新建 Servlet

package com.peterjxl.servlet;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
public class ServletDemo1 extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        doPost(req, resp);
    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        req.getRequestDispatcher("/index.jsp").forward(req, resp);
    }
}

‍

配置 web.xml

在 web.xml 里配置映射关系：

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">

    <servlet>
        <servlet-name>demo1</servlet-name>
        <servlet-class>com.peterjxl.servlet.ServletDemo1</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>demo1</servlet-name>
        <url-pattern>/hello</url-pattern>
    </servlet-mapping>
</web-app>

新建 index.jsp

在 webapp 目录下新建 index.jsp，内容如下：

<%@ page import="java.io.InputStream" %>
<%@ page import="org.apache.ibatis.io.Resources" %>
<%@ page import="org.apache.ibatis.session.SqlSessionFactoryBuilder" %>
<%@ page import="org.apache.ibatis.session.SqlSessionFactory" %>
<%@ page import="org.apache.ibatis.session.SqlSession" %>
<%@ page import="com.peterjxl.dao.IUserDao" %>
<%@ page import="com.peterjxl.domain.User" %>
<%@ page import="java.util.List" %>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
    <head>
        <title>Hello JNDI</title>
    </head>
    <body>
        <%
            InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
            SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
            SqlSessionFactory factory = builder.build(in);
            SqlSession sqlSession = factory.openSession();
            IUserDao userDao = sqlSession.getMapper(IUserDao.class);
            List<User> users = userDao.findAll();
            for(User user : users){
                System.out.println(user);
            }
            sqlSession.clearCache();
            in.close();
        %>
    </body>
</html>

‍ 其实 index.jsp 的内容， 就是测试方法了的内容。因为此时测试类里的方法是不能运行的，因为 Junit 不是 容器，无法提供 JNDI 服务。而 JSP 是经过服务器的，所以可以获取到数据源信息。

注意 JSP 里有内置对象 session，所以之前我们的 SqlSession session 变量得换个名字，这里改名为 sqlSession

测试

我们打个 war 包

mvn package

‍ 然后讲该 war 包重命名为 LearnMybatis.war，并放到 Tomcat 的 webapp 目录下，启动 Tomcat，访问 http://localhost: 8080/LearnMybatis，可以看到日志里能正常打印查询出来的数据。

‍

源码

本文所有代码已上传到了 GitHub (opens new window) 和 Gitee (opens new window) 上，并且创建了分支 demo16，读者可以通过切换分支来查看本文的示例代码。