Spring Boot 3.1.1配置嵌入式Tomcat JNDI数据源兼容外部Tomcat部署

核心思路 #

保持spring.datasource.jndi-name配置统一，通过环境Profile区分实现本地开发与服务器部署的无缝切换：本地启动时让嵌入式Tomcat自动绑定指定JNDI路径的数据源，部署到外部Tomcat时直接复用服务器已配置的JNDI资源，全程无需修改配置文件。

步骤1：统一application.yml基础配置 #

不管本地还是服务器环境，保持JNDI名称一致，示例：

spring:
  datasource:
    jndi-name: java:comp/env/jdbc/YourDB

步骤2：本地开发环境配置嵌入式Tomcat JNDI #

创建仅在本地生效的配置类，让嵌入式Tomcat注册对应JNDI数据源：

import org.apache.tomcat.util.descriptor.web.ContextResource;
import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.context.annotation.Profile;
import org.springframework.stereotype.Component;

import javax.naming.Context;
import javax.naming.InitialContext;
import javax.naming.NamingException;
import javax.sql.DataSource;

@Component
@Profile("local") // 仅本地开发环境激活
public class LocalTomcatJndiConfig implements WebServerFactoryCustomizer<TomcatServletWebServerFactory> {

    @Override
    public void customize(TomcatServletWebServerFactory factory) {
        // 定义本地JNDI资源
        ContextResource resource = new ContextResource();
        resource.setName("jdbc/YourDB");
        resource.setType(DataSource.class.getName());
        resource.setProperty("driverClassName", "com.mysql.cj.jdbc.Driver"); // 替换为你的数据库驱动
        resource.setProperty("url", "jdbc:mysql://localhost:3306/your_local_db"); // 本地库地址
        resource.setProperty("username", "your_local_user"); // 本地用户名
        resource.setProperty("password", "your_local_pwd"); // 本地密码

        // 绑定到Tomcat上下文
        factory.addContextCustomizers(context -> {
            context.getNamingResources().addResource(resource);
            try {
                Context initCtx = new InitialContext();
                Context envCtx = (Context) initCtx.lookup("java:comp/env");
                envCtx.bind("jdbc/YourDB", context.getNamingResources().findResource("jdbc/YourDB").getResource());
            } catch (NamingException e) {
                throw new RuntimeException("本地JNDI数据源绑定失败", e);
            }
        });
    }
}

在本地配置文件application-local.yml中激活该Profile：

spring:
  profiles:
    active: local

步骤3：外部Tomcat部署配置 #

1. 确认外部Tomcat的conf/context.xml（或应用专属META-INF/context.xml）已配置相同JNDI路径的数据源，示例：

<Resource name="jdbc/YourDB"
          auth="Container"
          type="javax.sql.DataSource"
          maxTotal="100"
          maxIdle="30"
          maxWaitMillis="10000"
          username="server_db_user"
          password="server_db_pwd"
          driverClassName="com.mysql.cj.jdbc.Driver"
          url="jdbc:mysql://server-db-host:3306/your_server_db"/>

2. 修改pom.xml打包为war包并排除内置Tomcat：

<packaging>war</packaging>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-tomcat</artifactId>
    <scope>provided</scope>
</dependency>

3. 启动类继承SpringBootServletInitializer以适配外部Tomcat：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;

@SpringBootApplication
public class YourApplication extends SpringBootServletInitializer {

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
        return application.sources(YourApplication.class);
    }

    public static void main(String[] args) {
        SpringApplication.run(YourApplication.class, args);
    }
}

验证逻辑 #

• 本地启动：激活local Profile，嵌入式Tomcat自动注册JNDI数据源，Spring Boot通过统一配置的jndi-name加载本地库。
• 服务器部署：war包放入外部Tomcat后，Spring Boot直接查找服务器已配置的同路径JNDI资源，无需修改任何配置。

注意事项 #

• 本地与服务器的JNDI路径必须完全一致，否则会出现查找失败问题。
• 数据库驱动需在pom.xml中引入，外部Tomcat也可将驱动放置到lib目录下。
• Profile名称可根据团队习惯调整，比如用dev-local替代local。

内容的提问来源于stack exchange，提问作者user2976594