DaoとRepositoryの使い方

Question

Spring bootにてWebアプリ開発を勉強中です。Domaでのデータアクセスをしようと思った時に疑問が出たので質問します。

参考にしているプロジェクト内でDaoとRepositoryを分けているプロジェクトを見つけたため何が違うのかと調べていたのですが、イマイチ理解できないでいます。

参考にしているプロジェクト

その中でDaoとRepositoryを分けている箇所は以下のような実装をしています。

package com.sample.domain.dao.users;

import java.util.List;
import java.util.Optional;
import java.util.stream.Collector;

import org.seasar.doma.*;
import org.seasar.doma.boot.ConfigAutowireable;
import org.seasar.doma.jdbc.SelectOptions;

import com.sample.domain.dto.user.User;
import com.sample.domain.dto.user.UserCriteria;

@ConfigAutowireable
@Dao
public interface UserDao {

    /**
     * ユーザーを取得します。
     *
     * @param criteria
     * @param options
     * @return
     */
    @Select(strategy = SelectType.COLLECT)
    <R> R selectAll(final UserCriteria criteria, final SelectOptions options, final Collector<User, ?, R> collector);

    /**
     * ユーザーを1件取得します。
     *
     * @param id
     * @return
     */
    @Select
    Optional<User> selectById(Long id);

    /**
     * ユーザーを1件取得します。
     *
     * @param criteria
     * @return
     */
    @Select
    Optional<User> select(UserCriteria criteria);

    /**
     * ユーザーを登録します。
     *
     * @param user
     * @return
     */
    @Insert
    int insert(User user);

    /**
     * ユーザーを更新します。
     *
     * @param user
     * @return
     */
    @Update
    int update(User user);

    /**
     * ユーザーを論理削除します。
     *
     * @param user
     * @return
     */
    @Update(excludeNull = true) // NULLの項目は更新対象にしない
    int delete(User user);

    /**
     * ユーザーを一括登録します。
     *
     * @param users
     * @return
     */
    @BatchInsert
    int[] insert(List<User> users);

    /**
     * ユーザーを一括更新します。
     *
     * @param users
     * @return
     */
    @BatchUpdate
    int[] update(List<User> users);
}

package com.sample.domain.repository.users;

import static com.sample.domain.util.DomaUtils.createSelectOptions;
import static java.util.Optional.ofNullable;
import static java.util.stream.Collectors.toList;

import java.util.Optional;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Repository;

import com.sample.domain.dao.system.UploadFileDao;
import com.sample.domain.dao.users.UserDao;
import com.sample.domain.dao.users.UserRoleDao;
import com.sample.domain.dto.common.Page;
import com.sample.domain.dto.common.Pageable;
import com.sample.domain.dto.user.User;
import com.sample.domain.dto.user.UserCriteria;
import com.sample.domain.dto.user.UserRole;
import com.sample.domain.exception.NoDataFoundException;
import com.sample.domain.service.BaseRepository;

import lombok.val;

@Repository
public class UserRepository extends BaseRepository {

    @Autowired
    UserDao userDao;

    @Autowired
    UserRoleDao userRoleDao;

    @Autowired
    UploadFileDao uploadFileDao;

    /**
     * ユーザーを取得します。
     * 
     * @param criteria
     * @param pageable
     * @return
     */
    public Page<User> findAll(UserCriteria criteria, Pageable pageable) {
        // ページングを指定する
        val options = createSelectOptions(pageable).count();
        val data = userDao.selectAll(criteria, options, toList());
        return pageFactory.create(data, pageable, options.getCount());
    }

    /**
     * ユーザーを取得します。
     * 
     * @param criteria
     * @return
     */
    public Optional<User> findOne(UserCriteria criteria) {
        // 1件取得
        val user = userDao.select(criteria);

        // 添付ファイルを取得する
        user.ifPresent(u -> {
            val uploadFileId = u.getUploadFileId();
            val uploadFile = ofNullable(uploadFileId).map(uploadFileDao::selectById);
            uploadFile.ifPresent(u::setUploadFile);
        });

        return user;
    }

    /**
     * ユーザー取得します。
     *
     * @return
     */
    public User findById(final Long id) {
        return userDao.selectById(id).orElseThrow(() -> new NoDataFoundException("user_id=" + id + " のデータが見つかりません。"));
    }

    /**
     * ユーザーを追加します。
     *
     * @param inputUser
     * @return
     */
    public User create(final User inputUser) {

        // 1件登録
        userDao.insert(inputUser);

        // 役割権限紐付けを登録する
        val userRole = new UserRole();
        userRole.setUserId(inputUser.getId());
        userRole.setRoleKey("users");
        userRoleDao.insert(userRole);

        return inputUser;
    }

    /**
     * ユーザーを更新します。
     *
     * @param inputUser
     * @return
     */
    public User update(final User inputUser) {

        val uploadFile = inputUser.getUploadFile();
        if (uploadFile != null) {
            // 添付ファイルがある場合は、登録・更新する
            val uploadFileId = inputUser.getUploadFileId();
            if (uploadFileId == null) {
                uploadFileDao.insert(uploadFile);
            } else {
                uploadFileDao.update(uploadFile);
            }

            inputUser.setUploadFileId(uploadFile.getId());
        }

        // 1件更新
        int updated = userDao.update(inputUser);

        if (updated < 1) {
            throw new NoDataFoundException("user_id=" + inputUser.getId() + " のデータが見つかりません。");
        }

        return inputUser;
    }

    /**
     * ユーザーを論理削除します。
     *
     * @return
     */
    public User delete(final Long id) {
        val user = userDao.selectById(id)
                .orElseThrow(() -> new NoDataFoundException("user_id=" + id + " のデータが見つかりません。"));

        int updated = userDao.delete(user);

        if (updated < 1) {
            throw new NoDataFoundException("user_id=" + id + " は更新できませんでした。");
        }

        return user;
    }
}

このようにRepositoryにてDaoをAutoweredしてメソッドを使用しています。

私の中のDaoとRepository

私の中で２つは「デザインパターンレベルでのデータを取得したり、操作するもの」という認識で、大きな違いはないと理解していました。
ただ今回使い分けているんだからなんか違うんだろう、そして同じプロジェクトで同じ階層で使用すべきものなのだろうと思って調査をしました。

１.DaoとRepositoryのすみ分け

Repositoryはドメインオブジェクトを見て、DAOはデータ・ソースのマッピングするDTOの方を見る

「ベクトルが違うのはなんとなく伝わるけどまだわからない」
次！！！

2.リポジトリとDaoの住み分け方より

・リポジトリはドメインオブジェクトのコレクション
・DAOはデータアクセスのメカニズムを隠蔽する

・リポジトリの実装はドメインオブジェクトの構築です。

んー、頭の中で噛み砕けない。。。
恥ずかしながら私はデザインパターンを学んだ事がなく、こういう話は理解するのに苦労します。

SESの世界に例えた時に、簡単に言うと「二次請け企業と三次請け企業」のようにレイヤーが異なるという事でしょうか？
もう少し抽象的で構わないので子供に理解できるレベルの日本語で解説するとしたらどのような感じになりますでしょうか？
ご意見をよろしくお願いします。
また、皆さんの現場ではDaoとRepositoryは分けられていますか？

Comments

[wwbQzhMkhhgEmhU]

ざっくり↓なイメージですが、特別両者を同じような位置付けで見たことがなかったです。
DAO=データベース周り
Repository=それ以外
日本でリポジトリという言葉が使われ始めたのは、2000年くらいからだと思いますが、以来〇〇リポジトリでしっくり来る箱のときはリポジトリと呼んでる感じです。私が初めて知ったのはsvnを触ったときでした。ユーザーリポジトリはしっくり来る感じですし、Springでもそういうのあった気がします。
私はOO〜最近巡り巡って何故かまたDDDまでほとんど知らないので、使い方は適当ですけどね。

[sanezane]

なるほど。私はSESで、開発案件としてまだ２件しか参画していませんでしたので、普通はどういう使い方をしているのか気になりました。
もう少しデザインパターンについて勉強したいと思います。

[A-pZ]

回答は解答欄に入力しましょう

Answer 1

SpringFrameworkが提案するRepositoryは、ドメイン駆動デザインのRepositoryとして用意され、JavaEEのDataAccessObject(DAO)と全く同じ扱いにもできますが、RepositoryはDAOよりも抽象度が高く、Repositoryを利用する側からは、どのデータストアに対して検索や更新しているかを意識せずに利用できるように設計・実装されるべき、とされています。

例えば何らかの検索機能を提供する際に、RDBから検索してした機能以外にも他のストレージやWebサービスへ切り替えるときに、これらを直接検索している処理はDAOで行わせ、DAOを切り替えることでRepositoryは常に期待する結果を返却するインタフェースを提供します。

https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/stereotype/Repository.html

もちろん実際にDAOが扱うデータストアが単一の場合も多いでしょうから、Repository＝DAOとしてしまうケースも多いでしょうし、DAOで利用するフレームワークを使うと、よりさらに違いがないと感じられる場面も多いでしょう。

アンチパターンも含めて、こちらに具体的な、砕けた例も書かれていますので参考になれば幸いです。

https://qiita.com/mikesorae/items/ff8192fb9cf106262dbf

Comments

[sanezane]

Repositoryは永続化する機能に絞って複雑な条件の処理はServiceで実装する。
アンチパターンに気をつけて過ごします。
Qiitaの記事わかりやすかったです。ありがとうございます。