README_zh.md

play-dbx 👉 for English

play-dbx是一个事务管理框架/类库，源代码移植于SpringFramework，并去除无关类和依赖。核心接口为Transactional和TransactionManagerLookup(也是需要用户扩展定制的Trait)，并提供了DBApi的简单实现。目前仅提供对 Scala 2.11 且 Play 2.5+ 版本支持。

项目设置（build.sbt）

libraryDependencies += "com.lingcreative" %% "play-dbx" % "1.0.4"

使用（以Anorm为例）

依赖注入

//app/Module.scala

class Module extends AbstractModule {
  override def configure(): Unit = {
    //绑定默认DBApi的TransactionManagerLookup实现
    bind(classOf[TransactionManagerLookup]).to(classOf[SimpleDBApiTransactionManagerLookup])

    //绑定默认DBApi的Transactional实现,其实现逻辑为：每个数据源用单独的一个事务管理器来管理事务
    val transactionalKey = new TypeLiteral[Transactional[Connection]](){}
    bind(transactionalKey).to(classOf[SimpleDBApiTransactional])

    //设定事物的默认属性（这里使事物级别为 __可重复读__ 并 使application.conf里配置的default1数据库源为默认数据源）
    //参考[[dbx.transaction.Transactional]]、[[dbx.transaction.Transactional.TransactionSettings]]
    val settings = TransactionSettings(isolation = Isolation.REPEATABLE_READ, resource = "default1")
    bind(classOf[TransactionSettings]).toInstance(settings)
  }
}

或者

// in application.conf
play {
    modules {
        enabled += dbx.api.SimpleModule
    }
}
dbx {
    transactionSettings {
        resource = default1
        isolationLevel = REPEATABLE_READ
    }
}

代码使用(这段代码修改自play-anorm)

import java.sql.Connection
import javax.inject._

import anorm.SqlParser._
import anorm._

// 导入主接口
import dbx.api.Transactional

case class Company(id: Option[Long] = None, name: String)

@Singleton
class CompanyService @Inject() (
    transactional: Transactional[Connection]/*注入Module.scala中配置的Transactional*/) {

  /**
   * Parse a Company from a ResultSet
   */
  val simple = {
    get[Option[Long]]("company.id") ~
      get[String]("company.name") map {
      case id~name => Company(id, name)
    }
  }

  /**
   * 按照Module.scala中配置的属性执行事务操作, ` transactional ` 对象的使用方法与Spring的
   * `@Transactional` 注解一致
   */
  def options: Seq[(String,String)] = transactional() { implicit connection =>
    SQL("select * from company order by name").as(simple *).
      foldLeft[Seq[(String, String)]](Nil) { (cs, c) =>
      c.id.fold(cs) { id => cs :+ (id.toString -> c.name) }
    }
  }

  /**
   * 让 ` transactional ` 使用default数据源里的JDBC连接(及对应的事物管理器),并关闭只读属性（即可执行更新操作）。
   * 与在Spring里给方法添加注解 ` @Transactional(readOnly=true, transactionManager="default") ` 一致
   */
  def save(company: Company): Unit = transactional(readOnly = false, resource = "default") {
  implicit connection =>
    // execute sql update statements here ...
  }

}

JTA支持（BTM）

参考BTM配置

Enjoy it! 🍵