Eff 项目使用教程

Eff 项目使用教程

eff 🚧 a work in progress effect system for Haskell 🚧 项目地址: https://gitcode.com/gh_mirrors/eff2/eff

1. 项目介绍

Eff 是一个为 Haskell 语言设计的工作中的效果系统（effect system）。它旨在通过类型级别的跟踪和灵活的方式处理效果，提供一个通用的解决方案。与其他现有的效果系统相比，Eff 具有以下特点：

• 高性能：基于 GHC RTS 添加的低级原语构建，Eff 在设计上具有高性能。它使用直接的限定控制实现，避免了依赖于编译器优化的间接调用。
• 低样板代码：即使不使用 Template Haskell 或任何泛型编程，Eff 的接口也与 freer-simple 和 polysemy 相当。通过一组高度表达的核心操作，编写新的效果处理程序变得更加简单。
• 表达性强：Eff 支持一阶/代数效果和更高阶/作用域效果，类似于 fused-effects 和 polysemy，但不同于 freer-simple。
• 语义精确：基于限定控制模型，Eff 的语义易于推理，且不受处理程序顺序的影响。

2. 项目快速启动

环境准备

在开始之前，确保你已经安装了 Haskell 的编译器 GHC 和包管理器 Cabal。你可以通过以下命令检查是否已安装：

ghc --version
cabal --version

如果没有安装，可以通过以下命令安装：

sudo apt-get install ghc cabal-install

安装 Eff

由于 Eff 是一个工作中的项目，目前需要特定的 GHC 版本支持。你可以通过以下步骤克隆项目并构建：

git clone https://github.com/lexi-lambda/eff.git
cd eff
cabal build

示例代码

以下是一个简单的示例，展示了如何定义一个自定义的 FileSystem 效果，并使用两个处理程序（一个在 IO 中运行，另一个使用内存中的虚拟文件系统）：

import qualified System.IO as IO
import Prelude hiding (readFile, writeFile)
import Control.Effect

-- 效果定义
data FileSystem :: Effect where
  ReadFile :: FilePath -> FileSystem m String
  WriteFile :: FilePath -> String -> FileSystem m ()

readFile :: FileSystem :< effs => FilePath -> Eff effs String
readFile = send . ReadFile

writeFile :: FileSystem :< effs => FilePath -> String -> Eff effs ()
writeFile a b = send $ WriteFile a b

-- IO 处理程序
runFileSystemIO :: IOE :< effs => Eff (FileSystem ': effs) a -> Eff effs a
runFileSystemIO = interpret \case
  ReadFile path -> liftIO $ IO.readFile path
  WriteFile path contents -> liftIO $ IO.writeFile path contents

-- 纯处理程序
runFileSystemPure :: Error String :< effs => Eff (FileSystem ': effs) a -> Eff effs a
runFileSystemPure = lift >>> interpret \case
  ReadFile path -> do
    fileSystem <- get
    case lookup path fileSystem of
      Just contents -> pure contents
      Nothing -> throw ("readFile: no such file " <> path)
  WriteFile path contents -> do
    fileSystem <- get
    put ((path, contents) : filter ((/= path) . fst) fileSystem)
    >>> evalState @[(FilePath, String)] []

3. 应用案例和最佳实践

应用案例

Eff 可以用于各种需要效果跟踪和处理的场景，例如：

• 并发编程：在并发环境中，Eff 可以帮助你管理多个并发任务的效果，确保它们在正确的上下文中执行。
• 错误处理：通过定义自定义的错误效果，你可以轻松地在程序中处理和传播错误。
• 资源管理：Eff 可以帮助你管理资源的获取和释放，确保资源在使用后正确释放。

最佳实践

• 模块化设计：将不同的效果和处理程序模块化，以便于维护和扩展。
• 性能优化：在编写处理程序时，注意性能优化，避免不必要的间接调用。
• 测试驱动开发：使用测试驱动开发（TDD）方法，确保每个效果和处理程序的行为符合预期。

4. 典型生态项目

Eff 作为一个效果系统，可以与其他 Haskell 生态项目结合使用，例如：

• MTL（Monad Transformer Library）：虽然 MTL 是一个传统的 monad 变换库，但 Eff 可以作为其替代方案，提供更灵活的效果处理。
• Freer Monads：Freer Monads 是另一个流行的效果系统，Eff 可以与其结合使用，提供更强大的效果处理能力。
• Polysemy：Polysemy 是一个现代的效果系统，Eff 可以与其结合使用，提供更丰富的效果处理功能。

通过结合这些生态项目，你可以构建更复杂和强大的应用程序，同时保持代码的清晰和可维护性。

eff 🚧 a work in progress effect system for Haskell 🚧 项目地址: https://gitcode.com/gh_mirrors/eff2/eff