springboot-maven项目+jpa 运行过程中执行resources下sql脚本文件-ClassPathResource和ScriptUtils.executeSqlScript的使用

简介: springboot-maven项目+jpa 运行过程中执行resources下sql脚本文件-ClassPathResource和ScriptUtils.executeSqlScript的使用

要完成上述需求,需要分两步操作

  • 获取resources目录下的sql脚本文件
  • 执行该文件

获取resources目录下的sql脚本文件


一般来说,项目的配置文件及静态资源都会放置在resources目录下。如下图


00a73497fb0d4cac9bc760c8d04911f4.png

当需要在java代码中使用resources目录下的文件时,就需要先获取该文件了

以获取上图test.sql文件为例,方法有二


方法一:

//这种方法在linux下无法工作
File sourceFile = ResourceUtils.getFile("classpath:db/test.sql");


⚠️:这种方法在linux下无法工作,我未采用

方法二:

我使用的是第二种。


import org.springframework.core.io.Resource;
// ... 忽略部分代码
Resource resource = new ClassPathResource("db/test.sql");
//获取到resource对象后,可以调用resouce.getFile()方法来获取文件。
File sourceFile = resource.getFile();

通过Resouce的实现类ClassPathResource来new一个对象。

该构造方法的参数是resources目录下的文件路径,注意这里是使用的相对路径(相对于resouces目录而言的)


尝试使用但未成功的方法


//通过入参相对路径或绝对路径都没有获取成功
Class.getResource("")获取相对于当前类的相对路径
Class.getResource("/")获取classpath的根路径
ClassLoader.getResource("")获取classpath的根路径


执行该sql文件


使用 Spring 提供的工具类执行 sql 文件


我是通过jpa来简化对数据库的操作,所以采用了Spring的工具类;如果用的是mybatis,可以直接跳过看下面

import javax.sql.DataSource;
import org.springframework.core.io.Resource;
import org.springframework.jdbc.datasource.init.ScriptUtils;
// ... 忽略部分代码
DataSource dataSource = createDataSource();  
Resource resource = new ClassPathResource("db/test.sql");
ScriptUtils.executeSqlScript(dataSource.getConnection(), resource);

使用mybatis方式执行 sql 文件

使用的是mybatis的ScriptRunner方法

直接上代码


/**
 * 使用ScriptRunner执行sql文件
 */
public class ExecuteSql {
    @Autowired
    private DataSource dataSource; // 获取数据库连接对象
    public static void main(String[] args) {
        try {
            executeSqlFile("db/test.sql");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
    private void executeSqlFile(String sqlFileName) throws Exception {
        // 获取连接对象
        Connection conn = dataSource.getConnection();
        //或者直接指明数据库
        //Class.forName(className);
        //Connection conn = DriverManager.getConnection(dbUrl, dbUsername, dbPassword);
        try {
            // 设置不自动提交
            conn.setAutoCommit(false);
            // 初始化ScriptRunner
            ScriptRunner runner = new ScriptRunner(conn);
            // 设置不自动提交
            runner.setAutoCommit(false);
            // true,遇见错误会停止执行,打印并抛出异常,捕捉异常,并进行回滚,保证在一个事务内执行;
            // false,遇见错误不会停止,会继续执行,会打印异常信息,并不会抛出异常,当前方法无法捕捉异常无法进行回滚操作,无法保证在一个事务内执行;
            runner.setStopOnError(true);
            // true则获取整个脚本并执行;
            // false则按照自定义的分隔符每行执行;
            runner.setSendFullScript(false);
            // 定义命令间的分隔符
            runner.setDelimiter(";");
            runner.setFullLineDelimiter(false);
            // 设置是否输出日志,null不输出日志,不设置自动将日志输出到控制台
            runner.setLogWriter(null);
            // 读取文件
            Resource resource = new ClassPathResource(sqlFileName);
            File file = resource.getFile();
            // 如果有多个sql文件,可以写多个runner.runScript(xxx),
            runner.runScript(new InputStreamReader(new FileInputStream(file), StandardCharsets.UTF_8));
            // 执行
            conn.commit();
        } catch (Exception e) {
            conn.rollback();
            e.printStackTrace();
        } finally {
            conn.close();
        }
    }
}


jpa方式完整代码


import javax.sql.DataSource;
import org.springframework.core.io.Resource;
import org.springframework.jdbc.datasource.init.ScriptUtils;
// 获取连接对象
DataSource dataSource = createDataSource().getConnection();
//也可以下面这种方式直接指明
//Class.forName(className);
//Connection conn = DriverManager.getConnection(dbUrl, dbUsername, dbPassword);
Resource resource = new ClassPathResource("db/test.sql");
ScriptUtils.executeSqlScript(conn, resource);
//去检查数据库验证吧!


如果成功了,那么下面就不用看了


其他问题

找不到脚本文件

报错


看到有情况是按照上述jpa方式执行了代码,但是仍然有类似找不到文件的报错

如:

java.io.FileNotFoundException: class path resource [db/test.sql] cannot be resolved to URL because it does not exist
     at org.springframework.core.io.ClassPathResource.getURL(ClassPathResource.java:195)

分析


ClassPathResource方法是到 classPath* 下去找,然后在项目本地的目录下找classPath下是否有这个文件(maven的classPath在 “target\classes”目录下)


解决


可以检查下pom.xml文件,

可能是springboot的maven默认只加载了classPath同级目录下的文件,想要加载其他文件可以使用配置标签

如下:


<build>
  <resources>
      <resource>
        <directory>src/main/resources</directory>
        <includes>
        //相对路径
          <include>**/*.sql</include>
        </includes>
      </resource>
  </resources>
</build>


目录
相关文章
|
4月前
|
SQL 安全 Java
揭秘Spring Boot安全防线:如何巧妙抵御XSS与SQL注入的双重威胁?
【8月更文挑战第29天】随着互联网技术的发展,Web应用已成为社会不可或缺的一部分。Spring Boot作为高效构建Web应用的框架备受青睐,但同时也面临安全挑战,如XSS攻击和SQL注入。本文介绍如何在Spring Boot应用中防范这两种常见安全漏洞。针对XSS攻击,可通过输入验证、输出编码及使用安全API来加强防护;对于SQL注入,则应利用预编译语句、参数化查询及最小权限原则来确保数据库安全。示例代码展示了具体实现方法,帮助开发者提升应用安全性。
301 2
|
4月前
|
前端开发 JavaScript Java
【实操】SpringBoot监听Iphone15邮件提醒,Selenium+Python自动化抢购脚本
本文介绍了一个结合SpringBoot和Python的实用功能,旨在监控iPhone 15的库存状态并通过邮件提醒用户。系统采用SpringBoot监听苹果官网API,解析JSON数据判断是否有货,并展示最近的库存记录。此外,还能自动触发Selenium+Python脚本实现自动化购买。文中详细介绍了技术栈、接口分析、邮件配置及自动化脚本的设置方法。该项目不仅适用于熟悉后端开发的人员,也适合回顾Layui和Jquery等前端技术。
56 0
【实操】SpringBoot监听Iphone15邮件提醒,Selenium+Python自动化抢购脚本
|
4月前
|
Java 应用服务中间件 Spring
为什么SpringBoot的 jar 可以直接运行?
SpringBoot的 jar 可以直接运行的原因
453 2
|
1月前
|
Dubbo Java 应用服务中间件
深入探讨了“dubbo+nacos+springboot3的native打包成功后运行出现异常”的原因及解决方案
本文深入探讨了“dubbo+nacos+springboot3的native打包成功后运行出现异常”的原因及解决方案。通过检查GraalVM版本兼容性、配置反射列表、使用代理类、检查配置文件、禁用不支持的功能、查看日志文件、使用GraalVM诊断工具和调整GraalVM配置等步骤,帮助开发者快速定位并解决问题,确保服务的正常运行。
45 1
|
20天前
|
安全 Java 应用服务中间件
如何将Spring Boot应用程序运行到自定义端口
如何将Spring Boot应用程序运行到自定义端口
29 0
|
2月前
|
XML Java 应用服务中间件
【Spring】运行Spring Boot项目,请求响应流程分析以及404和500报错
【Spring】运行Spring Boot项目,请求响应流程分析以及404和500报错
212 2
|
2月前
|
SQL Java 关系型数据库
Springboot引入jpa来管理数据库
Springboot引入jpa来管理数据库
49 0
Springboot引入jpa来管理数据库
|
2月前
|
SQL Java 数据库连接
springBoot+Jpa(hibernate)数据库基本操作
springBoot+Jpa(hibernate)数据库基本操作
58 0
|
4月前
|
Java Maven 容器
Maven使用IDEA自带工具打包,同时将lib下的jar包打入,双击jar包可直接运行
使用IntelliJ IDEA的Artifacts功能,可以将项目依赖的第三方jar包打包进jar文件中,实现双击jar包即可直接运行。
Maven使用IDEA自带工具打包,同时将lib下的jar包打入,双击jar包可直接运行
|
3月前
|
JavaScript 前端开发 Java
用Maven运行JMeter
用Maven运行JMeter
36 0
用Maven运行JMeter

推荐镜像

更多