このプロジェクトにいろいろと実装をしていきたいです

https://github.com/jirentaicho/iroiro-spring

ここです

https://github.com/jirentaicho/Iroiro-spring/pull/1

参考：https://github.com/miyabayt/spring-boot-doma2-sample

SpringBoot2徹底活用

上記はgradleなのですが私は得意ではないのでMavenを利用します。また、この書籍は現場至上主義ということでソースコードの難易度が高く感じます。。

とりあえずjacksonが必要なのでpomに記載をします。

<dependency>
		    <groupId>com.fasterxml.jackson.dataformat</groupId>
		    <artifactId>jackson-dataformat-csv</artifactId>
		    <version>2.13.0</version>
		</dependency>

CSV出力をするには

jackson-dataformat-csvというライブラリを利用します。

CsvMapperを利用することで、オブジェクトからCSV形式で出力できそうです。

CSVでファイル出力する場合は以下のようになりそうです。

new CsvMapper()する
csvMapper.schemaFor(class).withHeader();でヘッダ情報をセットする
csvMapper.writer(schema).writeValue(writer, data);で出力する

AbstractView

AbstractViewについて知らなかったのですが、csv出力の箇所で出てきました。

CsvViewはAbstractViewを継承していてrenderMergedOutputModelメソッドにて、ゴリゴリにロジックの詳細を実装しています。

AbstractViewは、Viewインターフェースのrenderメソッドをオーバーライドしている。renderMergedOutputModelは、renderメソッドから呼び出されるので、オーバーライドする必要があります（抽象メソッド）

軽く動作を確認する

AbstractViewを継承したクラスに必要なメソッドのオーバーライドをしたものが以下になります。renderMergedOutputModelメソッドでは”call renderMergedOutputModel”と出力しています。これでこのメソッドが呼ばれるか確認できます。

package com.volkruss.iroiro.view;

import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.view.AbstractView;

public class TestCsv extends AbstractView{
	@Override
	protected void renderMergedOutputModel(Map<String, Object> model, HttpServletRequest request,
			HttpServletResponse response) throws Exception {
		System.out.println("call renderMergedOutputModel ");
	}
}

コントローラーでTesCsvクラスを利用します。ModelAndViewにセットして簡潔させるだけです。

package com.volkruss.iroiro.controller.testcsv;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.servlet.ModelAndView;

import com.volkruss.iroiro.view.TestCsv;

@Controller
public class TestCsvController {
	@GetMapping("/getcsv")
	public ModelAndView testcsv() {
		TestCsv view = new TestCsv();
		return new ModelAndView(view);
	}	
}

コンソールに出力されています。つまりrenderMergedOutputModelメソッドが呼ばれていることが確認できました。

出力対象とするクラスを作成する

出力対象とするシンプルなクラスを作成します

package com.volkruss.iroiro.controller.testcsv;

import lombok.AllArgsConstructor;

@AllArgsConstructor
public class TestData {
	public String title;
	public String protagonist;
}

次にTestCsvクラスを修正します。CsvMapperを利用して出力対象となるオブジェクトをCSV形式で出力するように修正します。

package com.volkruss.iroiro.view;

import java.util.Collection;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.web.servlet.view.AbstractView;

import com.fasterxml.jackson.dataformat.csv.CsvGenerator.Feature;
import com.fasterxml.jackson.dataformat.csv.CsvMapper;
import com.fasterxml.jackson.dataformat.csv.CsvSchema;

public class TestCsv extends AbstractView{
	
	// csvmapper
	protected final CsvMapper csvMapper = createMapper();
	
	// 出力するクラス
	protected Class<?> clazz;
	
	// 出力するデータ
	protected Collection<?> data;
	
	private CsvMapper createMapper() {
		CsvMapper mapper = new CsvMapper();
		mapper.configure(Feature.ALWAYS_QUOTE_STRINGS, true);
		mapper.findAndRegisterModules();
		return mapper;
	}
	
	// コンストラクタでクラスとデータを受取る
	public TestCsv(Class<?> clazz, Collection<?> data) {
		this.clazz = clazz;
		this.data = data;
	}
	@Override
	protected void renderMergedOutputModel(Map<String, Object> model, HttpServletRequest request,
			HttpServletResponse response) throws Exception {
		// ヘッダを設定する
		CsvSchema schema = this.csvMapper.schemaFor(clazz).withHeader();
		// TODO カラムが指定されたら指定カラムのみ出力する
		
		// csv形式で結果を取得する
		String result = csvMapper.writer(schema).writeValueAsString(data);
		System.out.println(result);
	}
}

どんなクラスでも出力できるようにジェネリクスを利用しているのは参考サイトをお手本にしています。

今回はファイル出力をしていないのでwriteValueメソッドでなくてwriteValueAsStringメソッドを利用しています。

コントローラーから利用する

今回は出力対象とするクラスをそのままインスタンス化して結果を見てみます

package com.volkruss.iroiro.controller.testcsv;

import java.util.List;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.servlet.ModelAndView;

import com.volkruss.iroiro.view.TestCsv;

@Controller
public class TestCsvController {
	@GetMapping("/getcsv")
	public ModelAndView testcsv() {
		
		// csv出力対象
		List<TestData> list = List.of(
				new TestData("俺の妹がこんなに可愛いわけがない", "高坂桐乃"),
				new TestData("ラブライブ!スーパースター!!", "嵐千砂都"),
				new TestData("とある科学の超電磁砲", "御坂美琴")
			);
		
		TestCsv view = new TestCsv(TestData.class, list);
		return new ModelAndView(view);
	}	
}

実行すると以下のようにコンソール出力されています

&quot;protagonist&quot;,&quot;title&quot;

&quot;高坂桐乃&quot;,&quot;俺の妹がこんなに可愛いわけがない&quot;

&quot;嵐千砂都&quot;,&quot;ラブライブ!スーパースター!!&quot;

&quot;御坂美琴&quot;,&quot;とある科学の超電磁砲&quot;

参考サイトではリポジトリから取得したUserクラスをUserCsvクラスにModelMapperで変換しています。 UserCsvクラスはJsonPropertyというアノテーションを持ったメンバを持っています。これらはjacksonの機能のようです。

このJsonPropertyを付与すればヘッダーとして認識してくれるようです。

modelMapperとの動きは見てないのですが、オブジェクトをマッピングする際に持ってないメンバは無視するなどもできるようです。

とりあえず簡単にJsonPropertyを付与して実行してみます

package com.volkruss.iroiro.controller.testcsv;

import com.fasterxml.jackson.annotation.JsonProperty;

import lombok.AllArgsConstructor;

@AllArgsConstructor
public class TestData {
	
	@JsonProperty("タイトル")
	public String title;
	
	@JsonProperty("主人公")
	public String protagonist;
}

&quot;タイトル&quot;,&quot;主人公&quot;

&quot;俺の妹がこんなに可愛いわけがない&quot;,&quot;高坂桐乃&quot;

&quot;ラブライブ!スーパースター!!&quot;,&quot;嵐千砂都&quot;

&quot;とある科学の超電磁砲&quot;,&quot;御坂美琴&quot;

想定通りの動きになりました。

AbstractViewについて考える

サクッと触れましたが結構わからない点が多いので少しソースを眺めてみます。

インスタンス化した時点ではログが吐かれていないですね。

DispatcherServletクラスのrenderメソッドにて呼び出しているようでした。

protected void render(ModelAndView mv, HttpServletRequest request, HttpServletResponse response) throws Exception {
		省略		
try {
			if (mv.getStatus() != null) {
				response.setStatus(mv.getStatus().value());
			}
			view.render(mv.getModelInternal(), request, response);
		}
		catch (Exception ex) {
			if (logger.isDebugEnabled()) {
				logger.debug("Error rendering view [" + view + "]", ex);
			}
			throw ex;
		}

とありましたので、当たり前かもしれませんが、レンダリングする際に呼ばれているようです。

SpringbootでCSV出力する