クラスパス内の静的ファイルにアクセスする　STS3 ＋Spring Boot ＋thymeleaf

絶対パス指定とかではなく、クラスパスからの相対パスでファイルを取得する方法をやってみます。

STS3(3.9.6)＋SpringBoot2.0＋Tymeleaf3.0迄動作確認しています。

f:id:arakan_no_boku:20190222012501j:plain

クラスパス内の静的ファイルにアクセスする方法

Spring Bootだと、これが簡単にできる方法があります。

src/main/resources　の下にフォルダを作ったり、ファイルを置いたりして、ResourceLoaderというクラスを使って、それにアクセスすることができます。

Spring Bootでアクセスする方法

準備として、src/main/resourcesの下い　data　というフォルダを作って、適当にファイルを置いておきます。

サンプルなので、適当にsample.txtとでも名前をつけておきます。

f:id:arakan_no_boku:20170330230302j:plain

ResourceLoaderクラス

アクセスは、コントローラクラスから行います。

それ以外から行おうとしてもうまくいかないので注意してください。

@Controller
public class Hello3Controller {
@Autowired
protected ResourceLoader resourceLoader;

@RequestMapping(value = "/hello3", method = RequestMethod.GET)
public String index(Hello3Form form, Model model) {
String pathAndFile = "data/sample.txt";
Resource resource = resourceLoader.getResource("classpath:" + pathAndFile);
model.addAttribute("resourceFileName",resource.getFilename());
return "hello3";
}

}

ResourceLoaderクラスは、@Autowiredして使えるようにします。

対象ファイルは、src/main/resources　からの相対パスで指定します。

今回は、”src/main/resources/data/sample.txt” を取得したいわけですか、"data/sample.txt"　です。

で、ResourceLoaderクラスの、getResourceメソッドを使って取得するわけですが、ポイントは、"classpath:”の文字列です。

これを相対パスの前につけておくことで、src/main/resources/以下の相対パスでResourceオブジェクトとしてファイルが取得できるようになります。

resourceLoader.getResource("classpath:" + pathAndFile);

Resourceオブジェクトを取得すれば、後はまあ普通にファイルをオープンして読んで処理をするだけです。

サンプルを作ってみます

サンプルでごちゃごちゃ書くとポイントがずれるので、今回は簡単にresourceオブジェクトからfilenameを取得して表示するだけのコードにしています。

試しに、表示するHTMLをこんな感じにしてみました。

<form role="form" id="hello3Form" action="/outpg01" th:action="@{/outpg01}" th:object="${hello3Form}" method="post">
<p class="msg" th:text="${resourceFileName}">Please input PID</p>

</form>

実行してみます。

f:id:arakan_no_boku:20170330232944j:plain