如何在Java Web项目中嵌入Apache Derby数据库实现可移植性

1. 数据库存放位置 #

将预先填充好的Derby数据库文件夹（比如mydb，包含所有Derby数据库文件）放到以下目录：

• Maven/Gradle项目：src/main/resources/db/（打包后会自动进入war包的classpath）
• 普通Web项目：WEB-INF/db/（同样会被包含到war包中，属于应用内部资源）

这个位置的核心优势是数据库会随war包一起分发，不会依赖部署机器的本地路径。

2. JDBC连接路径配置（解决读写与可移植性问题） #

由于classpath下的资源默认是只读的，而Derby嵌入式模式需要数据库目录具备可写权限（即使只读访问，也可能生成日志等文件），因此需要在应用启动时将classpath中的数据库复制到本地可写的临时目录，再连接该临时目录的数据库。

步骤1：实现数据库复制逻辑（应用启动时执行）

创建ServletContextListener，在应用初始化时完成数据库复制：

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import java.io.File;
import java.io.IOException;
import java.net.URISyntaxException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.StandardCopyOption;

public class DbInitializerListener implements ServletContextListener {

    @Override
    public void contextInitialized(ServletContextEvent sce) {
        String dbName = "mydb"; // 你的数据库文件夹名称
        String classpathDbDir = "/db/" + dbName;
        // 选择系统临时目录作为目标路径，也可以自定义其他可写路径
        String tempDbDir = System.getProperty("java.io.tmpdir") + File.separator + "myapp-" + dbName;

        try {
            copyDatabase(classpathDbDir, tempDbDir);
            // 将临时DB路径存入ServletContext，供后续JDBC使用
            sce.getServletContext().setAttribute("embeddedDbPath", tempDbDir);
        } catch (IOException | URISyntaxException e) {
            throw new RuntimeException("初始化嵌入式数据库失败", e);
        }
    }

    private void copyDatabase(String sourceClasspathPath, String destDirPath) throws IOException, URISyntaxException {
        File destDir = new File(destDirPath);
        if (destDir.exists()) {
            // 如果临时目录已存在，可选择跳过或覆盖，这里以覆盖为例
            deleteDirectory(destDir);
        }
        destDir.mkdirs();

        // 获取classpath中数据库的路径
        Path sourceRoot = Paths.get(getClass().getResource(sourceClasspathPath).toURI());
        // 递归复制所有文件和子目录
        Files.walk(sourceRoot)
             .forEach(sourcePath -> {
                 Path destPath = Paths.get(destDirPath).resolve(sourceRoot.relativize(sourcePath));
                 try {
                     Files.copy(sourcePath, destPath, StandardCopyOption.REPLACE_EXISTING);
                 } catch (IOException e) {
                     throw new RuntimeException("复制数据库文件失败: " + sourcePath, e);
                 }
             });
    }

    private void deleteDirectory(File dir) {
        File[] files = dir.listFiles();
        if (files != null) {
            for (File file : files) {
                deleteDirectory(file);
            }
        }
        dir.delete();
    }

    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        // 可选：应用关闭时清理临时数据库目录
        String tempDbDir = (String) sce.getServletContext().getAttribute("embeddedDbPath");
        if (tempDbDir != null) {
            deleteDirectory(new File(tempDbDir));
        }
    }
}

步骤2：配置JDBC连接

在Servlet或DAO类中，从ServletContext获取临时数据库路径，构建JDBC URL：

import javax.servlet.ServletContext;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;

public class DbUtil {
    public static Connection getConnection(ServletContext context) throws SQLException {
        String dbPath = (String) context.getAttribute("embeddedDbPath");
        // Derby嵌入式模式URL，create=false表示使用已存在的数据库
        String jdbcUrl = "jdbc:derby:" + dbPath + ";create=false";
        // 无需用户名密码（如果你的数据库没设置的话）
        return DriverManager.getConnection(jdbcUrl);
    }
}

步骤3：注册Listener

在web.xml中注册监听器（如果是Servlet 3.0+，也可以用@WebListener注解）：

<listener>
    <listener-class>com.yourpackage.DbInitializerListener</listener-class>
</listener>

只读场景简化方案 #

如果你的项目完全不需要修改数据库（仅只读访问），可以跳过复制步骤，直接使用classpath前缀的JDBC URL：

String jdbcUrl = "jdbc:derby:classpath:/db/mydb;create=false";
Connection conn = DriverManager.getConnection(jdbcUrl);

但注意：Derby在只读模式下仍可能尝试写入日志文件，部分环境下会抛出权限异常，因此更推荐前面的复制方案。

关键注意事项 #

• 确保derby.jar已添加到项目依赖（Maven可引入org.apache.derby:derby）或Tomcat的lib目录
• 打包war包时，确认数据库文件夹被正确包含（Maven/Gradle默认会打包src/main/resources下的所有内容）
• 临时目录的选择可根据需求调整，比如用户主目录下的专属文件夹，避免系统临时目录被清理

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