j5ik2o/okite-ai/repository-design

# NG: テーブル名ベース
OrdersTableRepository
UserAccountsRepository  (テーブル名 user_accounts に由来)
 
# NG: DTOベース
OrderDtoRepository
UserResponseRepository
 
# OK: 集約名ベース
OrderRepository
UserRepository

// Query: 単件取得
fun findById(id: OrderId): Order?
 
// Command: 単件保存
fun store(order: Order)

// Query: 複数件取得
fun findByIds(ids: List<OrderId>): List<Order>
 
// Command: 複数件保存
fun storeMulti(orders: List<Order>): Int

// Query: 例外でエラーを通知
fun findById(id: OrderId): Order?
 
// Command
fun store(order: Order)

// Query: Result型でエラーを返す
fun findById(id: OrderId): Result<Order?, RepositoryError>
 
// Command
fun store(order: Order): Result<Unit, RepositoryError>

// Query: Futureのエラー機構を使用
def findById(id: OrderId): Future[Option[Order]]
 
// Command
def store(order: Order): Future[Unit]

// Query
async fn find_by_id(&self, id: &OrderId) -> Result<Option<Order>, RepositoryError>;
 
// Command
async fn store(&self, order: &Order) -> Result<(), RepositoryError>;

// NG: DTOを返す
fun findById(id: OrderId): OrderDto
 
// NG: テーブル行を返す
fun findById(id: OrderId): OrderRecord
 
// NG: エンティティの一部を返す
fun findById(id: OrderId): OrderSummary
 
// OK: 集約を返す
fun findById(id: OrderId): Order?

// NG: ドメインロジックがリポジトリに漏れている
fun leave(userId: UserId)          // 「退会」はドメインの振る舞い
fun activate(orderId: OrderId)     // 「有効化」はドメインの振る舞い
fun cancel(orderId: OrderId)       // 「キャンセル」はドメインの振る舞い
fun approve(requestId: RequestId)  // 「承認」はドメインの振る舞い
fun rename(userId: UserId)         // 「名前の変更」はドメインの振る舞い
 
// NG: DB操作を想起するメソッド名(リポジトリはDB以外の実装もありえるため)
fun insert(order: Order)             // INSERT文を連想
fun update(order: Order)             // UPDATE文を連想
fun select(id: OrderId): Order?      // SELECT文を連想
fun upsert(order: Order)             // UPSERT文を連想
 
// OK: コレクションとしてのI/O操作
fun store(user: User)
fun put(order: Order)
fun add(order: Order)
fun delete(order: Order)
fun findById(id: OrderId): Order?
fun storeMulti(orders: List<Order>): Int
fun putAll(orders: List<Order>)
fun addAll(orders: List<Order>)
fun findByIds(ids: List<OrderId>): List<Order>

// 集約でドメインロジックを実行
val user = userRepository.findById(userId)
val leftUser = user.leave()  // 集約のメソッド
 
// リポジトリは保存するだけ
userRepository.store(leftUser)

// NG: リポジトリが別のリポジトリに依存
class OrderRepositoryImpl(
    private val productRepository: ProductRepository
) : OrderRepository {
    override fun store(order: Order) {
        val product = productRepository.findById(order.productId)
        // ...
    }
}
 
// OK: ユースケース層で調整
class PlaceOrderUseCase(
    private val orderRepository: OrderRepository,
    private val productRepository: ProductRepository,
) {
    fun execute(command: PlaceOrderCommand) {
        val product = productRepository.findById(command.productId)
        val order = Order.create(product.id, command.quantity)
        orderRepository.store(order)
    }
}

// NG: DTOを受け取る
fun store(dto: OrderDto)
 
// NG: 保存後のDBレコードを返す（CQS違反）
fun store(order: Order): OrderRecord
 
// NG: IDを返す（CQS違反）
fun store(order: Order): OrderId
 
// OK: 集約を受け取り、voidを返す
fun store(order: Order)