maven:sql-maven-plugin插件执行sql脚本

蔚落 2022-06-10 10:26 174阅读 0赞

[sql-maven-plugin][]插件提供了sql脚本的执行功能，允许用户执行指定的sql脚本文件或语句。

最近在进行一个项目是基于maven管理的java开发项目,其中有一个环节要对数据库初始化创建表，需要在maven中执行,正好有机会学习了sql-maven-plugin的使用.

> 关于sql-maven-plugin的详细说明参见[http://www.mojohaus.org/sql-maven-plugin][sql-maven-plugin]

下面的maven脚本实现的功能就是在mysql数据库中执行指定的sql脚本(create\_tables.sql)来创建表：

run-sql.xml

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
      <modelVersion>4.0.0</modelVersion>
      <groupId>yourGroupId</groupId>
      <artifactId>yourArtifactId</artifactId>
      
      <packaging>maven-plugin</packaging>
      <name>facelog-sql</name>
      <build>
        <plugins>        
          <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>sql-maven-plugin</artifactId>
            <version>1.5</version>
            <dependencies>
              
              <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.43</version>
              </dependency>  
            </dependencies>
            <configuration>
              
              <driver>com.mysql.jdbc.Driver</driver>
              <url>jdbc:mysql://localhost:3306/test</url>
              <username>root</username>
              <password></password>
              
              <srcFiles>
                  <srcFile>${project.basedir}/sql/create_tables.sql</srcFile>
              </srcFiles>
            </configuration>
          </plugin>
        </plugins>
      </build>
    </project>

运行方式如下:

# 因为上面的脚本我没有使用缺省的文件名pom.xml,所以maven执行的时候要用-f 指定文件名
    mvn -f run-sql.xml sql:execute

# 定义多个独立执行的execution #

上面的脚本可以一次性执行一个或多个sql脚本，如果我们希望每个脚本可以在命令行分别独立执行，那么就要定义多个execution来实现。  
比如我们将删除表的语句和建表语句分成两个文件(clean\_tables.sql,create\_tables.sql),希望在命令行分别执行两个脚本，那么 上面脚本就修改成如下的样子：

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
      <modelVersion>4.0.0</modelVersion>
      <groupId>net.gdface.facelog</groupId>
      <artifactId>facelog-sql</artifactId>
      
      <packaging>maven-plugin</packaging>
      <name>facelog-sql</name>
      <build>
        <plugins>        
          <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>sql-maven-plugin</artifactId>
            <version>1.5</version>
            <dependencies>
              
              <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.43</version>
              </dependency>  
            </dependencies>
            <configuration>
              
              <driver>com.mysql.jdbc.Driver</driver>
              <url>jdbc:mysql://localhost:3306/test</url>
              <username>root</username>
              <password></password>
            </configuration>
            <executions>
              
              <execution>
                <id>clean-tables</id>
                <configuration>
                  <srcFiles>
                    <srcFile>${project.basedir}/sql/clean_tables.sql</srcFile>
                  </srcFiles>
                </configuration>
              </execution> 
              
              <execution>
                <id>create-tables</id>
                <configuration>
                  <srcFiles>
                    <srcFile>${project.basedir}/sql/create_tables.sql</srcFile>
                  </srcFiles>
                </configuration>
              </execution> 
            </executions>
          </plugin>
        </plugins>
      </build>
    </project>

命令行执行如下：

# 通过@execution-id的方式指定执行id为‘clean-tables’的execution
    mvn -f run-sql.xml sql:execute@clean-tables
    # 通过@execution-id的方式指定执行id为‘create-tables’的execution
    mvn -f run-sql.xml sql:execute@create-tables

> 注意 Maven 3.3.1以上版本支持上述的@execution-id 的用法  
> 参见 [https://stackoverflow.com/questions/3166538/how-to-execute-maven-plugin-execution-directly-from-command-line][https_stackoverflow.com_questions_3166538_how-to-execute-maven-plugin-execution-directly-from-command-line]

参考资料:

[《sql-maven-plugin usage》][sql-maven-plugin usage]  
[《execute-mojo》][execute-mojo]  
[《Maven Properties Guide》][Maven Properties Guide]

[sql-maven-plugin]: http://www.mojohaus.org/sql-maven-plugin
[https_stackoverflow.com_questions_3166538_how-to-execute-maven-plugin-execution-directly-from-command-line]: https://stackoverflow.com/questions/3166538/how-to-execute-maven-plugin-execution-directly-from-command-line
[sql-maven-plugin usage]: http://www.mojohaus.org/sql-maven-plugin/usage.html
[execute-mojo]: http://www.mojohaus.org/sql-maven-plugin/execute-mojo.html
[Maven Properties Guide]: https://cwiki.apache.org/confluence/display/MAVEN/Maven+Properties+Guide