如何使用 Gradle 访问 Java 项目中的资源？

Question

我有一个 JavaFX 项目，正在使用 Gradle 文件构建，并且我正在 Intellij 中编写所有内容。在其中，我使用 javafx.scene.media.Media 和 javafx.scene.media.MediaPlayer 来播放一些音乐。

public SoundPlayer(String filename) {
    String soundLocation = "\\src\\main\\resources\\sound\\" + fileName;
    String absolute = new File("").getAbsolutePath() + soundLocation;
    System.out.println(absolute);
    Media soundMedia = new Media(new File(absolute).toURI().toString());
    mediaPlayer = new MediaPlayer(soundMedia);
}

我一直在使用的项目目录是：

来源/

|---主要/

|---|---java/

|---|---|---声音.SoundPlayer

|---|---资源/

|---|---|---声音/

|---|---|---|---click.mp3

|---|---|---|---bgm.mp3

但是，当我去编译并将其转换为 jar 文件时，Gradle 将目录更改为以下内容（在 jar 文件内，顶层）：

声音/

|---SoundPlayer.class

|---点击.mp3

|---bgm.mp3

这导致它抛出媒体异常：媒体不可用。我尝试将文件更改为以下两个：

Media soundMedia = new Media(new File("sound\\" + fileName).toURI().toString());

和

Media soundMedia = new Media(new File(fileName).toURI().toString());

...但我总是遇到同样的例外。发生什么事了？

Answer 1

Gradle 所做的一切完全在意料之中。 src/main/java 和 src/main/resources 目录分别存储代码和资源。 resources 文件夹包含所有非 java 代码，如图像、声音等。

创建jar文件时，resources目录的内容将被原样复制（保持包结构）。请注意，click.mp3和bgm.mp3是sound包的成员。

因此，当您想要加载资源时，（通常）不应该使用文件路径来完成。相反，使用包结构来执行此操作。这里，由于声音和

SoundPlayer

具有相同的包，即

sound

，您可以使用

SoundPlayer

类来加载资源，如下所示：

public SoundPlayer(String filename) {
    URL resource = SoundPlayer.class.getResource(filename);
    Media soundMedia = new Media(resource.toExternalForm());
    mediaPlayer = new MediaPlayer(soundMedia);
}

来自 Javadocs

公共字符串toExternalForm()
构造此 URL 的字符串表示形式。该字符串是通过调用该对象的流协议处理程序的 toExternalForm 方法创建的。

本质上，toExternalForm() 函数为给定资源创建适当的 URL。

这是一个完整的示例。

// build.gradle
apply plugin: 'java'
apply plugin: 'application'

sourceCompatibility = '1.8'
[compileJava, compileTestJava]*.options*.encoding = 'UTF-8'


mainClassName = 'sound.Main'

repositories {
    mavenCentral()
}

dependencies {
    testCompile group: 'junit', name: 'junit', version: '4.10'
}

jar { manifest { attributes 'Main-Class': 'sound.Main' } } 

和修改后的SoundPlayer

//sound.SoundPlayer
package sound;

import java.net.URL;
import javafx.scene.media.Media;
import javafx.scene.media.MediaPlayer;

public class SoundPlayer {

    private MediaPlayer mediaPlayer;

    public SoundPlayer(String filename) {
        URL resource = SoundPlayer.class.getResource(filename);
        Media soundMedia = new Media(resource.toExternalForm());
        mediaPlayer = new MediaPlayer(soundMedia);
    }

    public void play(){
        mediaPlayer.play();
    }
}

以及使用 SoundPlayer 的 Main 类

// sound.Main
// This class does not actually create a JavaFX UI. Instead, it is
// only creating a JavaFX application to use Media
package sound;

import javafx.application.Application;
import javafx.stage.Stage;

/**
 *
 * @author aga53
 */
public class Main extends Application{

    /**
     * @param args the command line arguments
     */
    public static void main(String[] args) {
        launch(args);
    }

    @Override
    public void start(Stage primaryStage) throws Exception {
        SoundPlayer s = new SoundPlayer("test.mp3");
        System.out.println("Hello World");
        s.play();
    }

}