実践クリーンアーキテクチャ

尹　官鎬より:

2019-07-22 17:23

Clean Architectureについて勉強をしています。あなたの説明は分かりやすくて助かりました。
DDD変もおかげでやっとわかった気がします。
1点だけ理解ができないことがありまして、教えていただきたいです。

Clean Architectureの依存関係はPresenter –> UseCase –> Entityの認識ですが、
コードにUseCase –> Presenter の依存関係があります。
UseCaseが常にPresenterを意識しなければならないことでしょうか？

返信

nrs より:

2019-07-31 01:20

参考になったようで幸いです。

Clean Architecture の解説を見る限り UseCase と Presenter は対になる関係にあるので、仰るとおりと考えております。

返信

乳牛より:

2019-10-16 18:36

Clean Architectureはいろいろな解釈があるので実装コードがあると助かります。

ところで本エントリ用のサンプルコードについて少し質問させていただければと思います。
https://github.com/nrslib/PracticeOfCleanArchitecture/tree/master/Src

Domainというcsprojの中に
* Application (Usecaseの実装？)
* Domain (Clean Archで言うEntity相当？)
を含む実装となっていますが、その意図はどのようなものでしょうか？

気になっているのは、以下の点です。
1. なぜUsecaseインターフェースと実装でcsprojを分けた（Usecaseレイヤを二分した）のか
* ControllerのUnitTest時にUsecase実装を差し替える効果があるのは理解できます
* しかし、同じcsprojに同居でも良いのでは
2. なぜUsecaseレイヤとEntityレイヤを同居させたのか
* Clean Arch的にはEntityレイヤを独立させることに執着しているように見える（私の解釈です）ので、UsecaseとEntityが離れている方が自然に思えた
3. 上記２の結果的に csproj間依存でものを見るとEntity -> UsecaseのClean Arch的には逆方向依存にも見える

こう書いてみるといちゃもんつけているようですが、そのような意図はなく、自身がClean Archの解釈に悩むところで色んな人の解釈を聞いてみたいなというところです。

気が向いたら教えていただけますと幸いです。

返信

nrs より:

2019-10-16 20:05

非常に鋭い質問です。同時にそこまでソースコードをご閲覧いただいたことを嬉しく思います。

> 1. なぜUsecaseインターフェースと実装でcsprojを分けた（Usecaseレイヤを二分した）のか

おっしゃるとおり、やりたかったのは本番用実装とコントローラーのテスト用実装を分けたかっただけです。
本番用実装とテスト用のスタブ実装をフラットに見ていたため、インターフェースと実装を分けています。
インターフェースと本来の実装（本番用実装）を同一の csproj に配置するのも良い案に感じます。

> 2. なぜUsecaseレイヤとEntityレイヤを同居させたのか

Domain に配置される User のメソッドを internal にし、意図した Interactor 群以外から呼び出しができないように制御したいという考えが根底にありました。（サンプルを見るとそういったふるまいがないですね）
Domain に所属するものは結局特定の Interactor 群（Application 以下）を前提にする場合が多く、別の Interactor 群から呼び出されることが少ないという経験も、上記の対応を後押ししています。
……迷わせることになるのでこれをお伝えするかは悩むところなのですが、Application と Domain を別のパッケージに分けるという趣旨の書き物をしています。これは複数の Application から利用することを想定し、フラットに見せるためです。

最後に、今回ご質問いただいたことで気づいたのですが、どうやら私はレイヤー同士の依存でなく、レイヤーに所属するオブジェクト同士の依存を重要視しているようです。
そのため、csproj 同士の依存やレイヤー分けは最大限憂慮するが、安全性（不用意なメソッド呼び出しを防ぐなど）や言語的制約に基づいてそれを曲げることは多いです。

質問する上での配慮などもありがとうございました。
個人の意見も含まれているこちらで回答になれば嬉しいです。

返信

乳牛より:

2019-10-16 23:02

早速のレスありがとうございます！

> Domain に配置される User のメソッドを internal にし、意図した Interactor 群以外から呼び出しができないように制御したいという考えが根底にありました。

なるほど、だからUnitTestをUsecaseInteractorを対象としていたのですね。

> Application と Domain を別のパッケージに分けるという趣旨の書き物をしています。これは複数の Application から利用することを想定し、フラットに見せるためです。

ここの考えわかります。自分は逆向きで悩んでいまして、Bobおじさん思想を強く意識するなら、

> the entities could be used by many different applications in the enterprise.

いろんなApplicationから使われるEntityを独立させるべきだよなぁと思いつつ、

> Domain に所属するものは結局特定の Interactor 群（Application 以下）を前提にする場合が多く、別の Interactor 群から呼び出されることが少ないという経験

実際問題こうなんですよね・・・。そしてDDDの文脈でのDomainServiceの概念も混ざると何がApplication Specific Ruleで何がEnterprise Wide Ruleなのか線引きが難しくなり「そんなにここ大事？」と思ったりもしなくもなかったりします。
そうなるとUsecase/Entityをビジネスロジックとしてひと括りに扱ってもいいんじゃないかと思い始めていました。（内部でEntity->Usecase方向依存はしないように注意するにしても）

####
蛇足ですが、私はBobおじさんの思想を
* Entity (=Enterprise wide business rules) こそ至高
* EntityをTestableにするために依存をコントロールせよ
と解釈していましたが、改めてBobおじさんの原文を読み返すと、

> Testable. The business rules can be tested without the UI, Database, Web Server, or any other external element

“Enterprise wide”をことさら持ち上げてはいませんでした。（どこかで私の認識が曲がったようです）
####

お時間を取って回答していただき感謝です！

返信

nrs より:

2019-10-25 14:08

いえいえ、こちらこそ鋭い質問でどぎまきしました。
また自分のコードで伝わりきらなかった部分がコメントで浮き彫りになり、後からこの記事を見る方へのメッセージになると思います。
ありがとうございました。

返信

	// ユーザ作成処理クラス
	public class CreateUser {
	private readonly UserRepository userRepository;

	public CreateUser(UserRepository userRepository){
	this.userRepository = userRepository;
	}

	public void Execute(string name){
	var user = new User(name);
	this.userRepository.Save(user);
	}
	}

	public class UserRepository{
	public void Save(User user){
	// User の保存処理
	}
	}

	// ユーザ作成処理クラス
	public class CreateUser {
	private readonly IUserRepository userRepository;

	public CreateUser(IUserRepository userRepository){
	this.userRepository = userRepository;
	}

	public void Execute(string name){
	var user = new User(name);
	this.userRepository.Save(user);
	}
	}

	public interface IUserRepository{
	void Save(User user);
	}

	// ユーザ作成リクエスト
	public class UserCreateRequest {
	public UserCreateRequest(string userName){
	UserName = userName;
	}

	public string UserName { get; }
	}

	// ユーザ作成レスポンス
	public class UserCreateResponse {
	public UserCreateResponse(string userId){
	UserId = userId;
	}

	// 作成したユーザの ID
	public string UserId { get; }
	}

	public class ChangePermitRequest {
	public ChangePermitRequest(string userId, Role role){
	UserId = userId;
	Role = role;
	}

	public string UserId { get; }
	public Role Role { get; } // <- このような enum 等
	}

	public class UserRepository : IUserRepository {
	public User FindByUserName(string username) {
	using (var con = new MySqlConnection(Config.ConnectionString)) {
	con.Open();
	using (var com = con.CreateCommand()) {
	com.CommandText = "SELECT * FROM t_user WHERE username = @username";
	com.Parameters.Add(new MySqlParameter("@username", username));
	var reader = com.ExecuteReader();
	if (reader.Read()) {
	var id = reader["id"] as string;
	return new User(
	id,
	username
	);
	} else {
	return null;
	}
	}
	}
	}

	public void Save(User user) {
	using (var con = new MySqlConnection(Config.ConnectionString)) {
	con.Open();

	bool isExist;
	using (var com = con.CreateCommand()) {
	com.CommandText = "SELECT * FROM t_user WHERE id = @id";
	com.Parameters.Add(new MySqlParameter("@id", user.Id.Value));
	var reader = com.ExecuteReader();
	isExist = reader.Read();
	}

	using (var command = con.CreateCommand()) {
	command.CommandText = isExist
	? "UPDATE t_user SET username = @username, firstname = @firstname, familyname = @familyname WHERE id = @id"
	: "INSERT INTO t_user VALUES(@id, @username, @firstname, @familyname)";
	command.Parameters.Add(new MySqlParameter("@id", user.Id.Value));
	command.Parameters.Add(new MySqlParameter("@username", user.UserName.Value));
	command.Parameters.Add(new MySqlParameter("@firstname", user.Name.FirstName));
	command.Parameters.Add(new MySqlParameter("@familyname", user.Name.FamilyName));
	command.ExecuteNonQuery();
	}
	}
	}
	}

実践クリーンアーキテクチャ

Qiita 版

はじめに

ソース

レイヤー

Enterprise Business Rules

Application Business Rules

Interface Adapters

Frameworks & Drivers

矢印の方向

とにかくやってみよう

登場人物

UseCase

Repository

Interactor

Controller

コンストラクタに渡されるものは

処理の流れ

何が嬉しいか

フロントエンドのテスト

バックエンドのテスト

Presenter

表示のためのオブジェクト

Flow of control

UseCase 沢山問題

Bus パターン

テストとプロダクトの切り替え

冗長性とその解決策

アーキテクチャの防衛

ClArc

まとめ

Architectureカテゴリの最新記事

実践クリーンアーキテクチャ with Java

ドメイン駆動設計のエンティティとクリーンアーキテクチャのエンティティ

実践クリーンアーキテクチャ

クリーンアーキテクチャの右下の図

Clean Architecture

Hexagonal Architecture

	public interface IUserCreateUseCase {
	UserCreateUseCaseResponse Handle(UserCreateUseCaseRequest request);
	}

	public interface IUserRespoitory{
	User FindByUserName(string userId);
	void Save(User user);
	}

	public class UserCreateInteractor : IUserCreateUseCase {
	private readonly IUserRepository userRepository;

	public UserCreateInteractor(IUserRepository userRepository){
	this.userRepository = userRepository;
	}

	public UserCreateResponse Handle(UserCreateRequest request){
	var username = request.UserName;
	var duplicateUser = userRepository.FindByUserName(username);
	if(duplicateUser != null){
	throw new Exception("duplicated");
	}

	var user = new User(username);
	userRepository.Save(user);

	return new UserCreateResponse(user.Id);
	}
	}

	public class UserController : Controller {
	private readonly IUserCreateUseCase usecase;

	public UserController(IUserCreateUseCase usecase){
	this.usecase = usecase;
	}

	public IActionResult Create(UserCreateRequestViewModel viewModel){
	var userName = viewModel.UserName;

	var request = new UserCreateRequest(userName);
	var response = usecase.Handle(request);

	var result = new UserCreateResponseViewModel(response.UserId);
	return View(result);
	}
	}

	var serviceCollection = new ServiceCollection();

	// IUserRepository が要求されたら UserRepository を渡す
	serviceCollection.AddTransient<IUserRepository, UserRepository>();

	// UserCreateInteractor をコンストラクタで UserCreateInteractor を生成して渡す
	serviceCollection.AddTransient<IUserCreateUsecase, UserCreateInteractor>();

	var provider = serviceCollection.BuildServiceProvider();
	// IUserCreateUseCase に登録されているインスタンスを取得（UserInteractor が取得される）
	var interactor = provider.GetService<IUserCreateUseCase>();

	public class Startup{
	public void ConfigureServices(IServiceCollection services)
	{
	services.AddMvc();

	serviceCollection.AddTransient<IUserRepository, UserRepository>();
	serviceCollection.AddTransient<IUserCreateUsecase, UserCreateInteractor>();
	}
	}

	public class MockUserCreateInteractor : IUserCreateUseCase {
	private static int id;

	public UserCreateResponse Handle(UserCreateRequest request){
	var currentId = id++;
	return new UserCreateResponse(currentId.ToString());
	}
	}

	public class InMemoryUserRepository : IUserRepository {
	private readonly Dictionary<string, User> data = new Dictionary<string, User>();

	public User FindByUserName(string username){
	var target = data.FirstOrDefault(x => x.UserName == username);
	if(target != null){
	return target.Value;
	}else{
	return null;
	}
	}

	public void Save(User user){
	data[user.UserId] = user;
	}
	}

	public interface IUserCreatePresenter{
	void Progress(int percentage);
	void Complete(UserCreateResponse response);
	}

	public class UserCreateInteractor : IUserCreateUseCase {
	private readonly IUserRepository userRepository;
	private readonly IUserCreatePresenter presenter;

	public UserCreateInteractor(
	IUserRepository userRepository,
	IUserCreatePresenter presenter
	){
	this.userRepository = userRepository;
	this.presenter = presenter;
	}

	public void Handle(UserCreateRequest request){
	presenter.Progress(10); // 10% 経過

	var username = request.UserName;
	var duplicateUser = userRepository.FindByUserName(username);

	presenter.Progress(30); // 30% 経過

	if(duplicateUser != null){
	throw new Exception("duplicated");
	}

	presenter.Progress(50); // 50% 経過

	var user = new User(username);

	presenter.Progress(80); // 80% 経過

	userRepository.Save(user);

	presenter.Complete(new UserCreateResponse(user.Id));
	}
	}

	public class ConsoleUserCreatePresneter : IUserCreatePresenter{
	public void Progress(int percentage){
	Console.WriteLine("進捗 " + percentage + "% です");
	}

	public void Complete(UserCreateResponse response){
	Console.WriteLine("完了しました");
	Console.WriteLine("作成されたユーザの ID は " + response.UserId + " です");
	}
	}

	[TestClass]
	public class UserCreateInteractorTest
	{
	[TestMethod]
	public void TestCreateUser() {
	var repository = new InMemoryUserRepository();
	var presenter = new UserCreateCollector();
	var interactor = CreateInteractor(repository, presenter);
	var request = new UserCreateRequest("TestUser");

	interactor.Handle(request);
	var expectedPercentages = new List<int> {
	10,
	30,
	50,
	80
	};
	Assert.IsTrue(expectedPercentages.SequenceEqual(presenter.Percentages));
	Assert.IsNotNull(presenter.Response);
	Assert.IsNotNull(presenter.Response.UserId);
	var inserted = repository.FindByUserName("TestUser");
	Assert.IsNotNull(inserted);
	}

	private IUserCreateUseCase CreateInteractor(
	IUserRepository repository,
	IUserCreatePresenter presenter
	) {
	return new UserCreateInteractor(repository, presenter);
	}
	}

	public class UserController : Controller {
	private readonly IUserCreateUseCase UserCreateUsecase;
	private readonly IGetUserUSeCase getUserUseCase;
	private readonly IUpdateUserUseCase updateUserUsecase;
	private readonly IDeleteUserUseCase deleteUserUsecase;

	public UserController(
	IUserCreateUseCase UserCreateUsecase,
	IGetUserUSeCase getUserUseCase,
	IUpdateUserUseCase updateUserUsecase,
	IDeleteUserUseCase deleteUserUsecase
	){
	this.UserCreateUsecase = UserCreateUsecase;
	this.getUserUseCase = getUserUseCase;
	this.updateUserUsecase = updateUserUsecase;
	this.deleteUserUsecase = deleteUserUsecase;
	}

	/* 省略 */
	}

	public class TestDILauncher : IDILauncher {
	public void Launch(IServiceCollection services) {
	services.AddSingleton<IUserRepository, InMemoryUserRepository>();

	var busBuilder = new SyncUseCaseBusBuilder(services);
	busBuilder.RegisterUseCase<CreateUserRequest, MockCreateUserInteractor>();

	var usecaseBus = busBuilder.Build();
	services.AddSingleton(usecaseBus);
	}
	}

	var repository = new UserRepository();
	var presenter = new ConsolePresenter();
	var interactor = new UserCreateInteractor(repository, presenter);
	var request = new UserCreateRequest("TestUser");
	interactor.Handle(request);

	public class UserCreateCollector : IUserCreatePresenter
	{
	public List<int> Percentages { get; } = new List<int>();
	public UserCreateResponse Response { get; private set; }

	public void Progress(int percentage) {
	Percentages.Add(percentage);
	}

	public void Complete(UserCreateResponse response) {
	Response = response;
	}
	}

	public interface IUserCreatePresenter {
	void Progress(int percentage); // ← このメソッドが呼ばれる
	void Complete(UserCreateResponse response);
	}

	public class UserController : Controller {
	private readonly UseCaseBus bus;

	public UserController(UseCaseBus bus){
	this.bus = bus;
	}

	public IActionResult Create(UserCreateRequestViewModel viewModel){
	var username = viewModel.UserName;

	var request = new UserCreateRequest(username);
	var response = bus.Handle(request);

	var result = new UserCreateResponseViewModel(response.Id);
	return View(result);
	}
	}

	public class ProductDILauncher : IDILauncher {
	public void Launch(IServiceCollection services) {
	services.AddTransient<IUserRepository, UserRepository>();

	var busBuilder = new SyncUseCaseBusBuilder(services);
	busBuilder.RegisterUseCase<CreateUserRequest, CreateUserInteractor>();

	var usecaseBus = busBuilder.Build();
	services.AddSingleton(usecaseBus);
	}
	}