引用子Snaplet的首选方法

Question

在Snap Framework中 ，Snaplet用于通过基于组件的界面将功能嵌入到其他Snaplet中：主Web应用程序是Snaplet，它通过经典的“ has-a”关系引用其他Snaplet，而子Snaplet可以依次引用其他Snaplets。

在查看各种Snaplet实现时，我看到了用于将Snaplet嵌入到父Snaplet中的不同模式。 特别：

• 参考种类。 Snaplet实现假定存在与父Snaplet的特定类型的关系。 这是通过使用的Reference方法强制执行的（请参见下文）。

  1. 一个简单的参考：

      data MySnaplet = MySnaplet { subSnaplet :: Snaplet SubSnaplet } 

  2. 相对镜头：

      data MySnaplet = MySnaplet { _subSnaplet :: Snaplet SubSnaplet } subSnaplet :: Lens MySnaplet SubSnaplet subSnaplet = lens _subSnaplet $ \\ ab -> a { _subSnaplet = b } 

• 参考方法。 Snaplet实现通过其接口强制采用一种访问Snaplet数据的特定方式，并且不同的Snaplet实现使用不同的方法。 Snaplet假定：

  1. 该数据存在于MonadState每次操纵Snaplet一个函数被调用时。
  2. 数据存在于MonadState并包装在Snaplet包装器中。
  3. 有一类+例如像instance HasSubSnaplet MySnaplet具有用于获取Snaplet数据输出的功能MySnaplet提供一个MySnaplet处于MonadState在调用函数的点。
  4. 3.中的函数改为键入MySnaplet -> Snaplet SubSnaplet 。
  5. 像3.中一样，有一个class + instance提供了Lens MySnaplet (Snaplet SubSnaplet) 。
  6. class + instance需要一个Lens (Snaplet MySnaplet) (Snaplet SubSnaplet) 。
  7. 类+实例假定MySnaplet是应用程序的“顶Snaplet”，并且需要绝对透镜/参考，使得MySnaplet必须是b在MonadSnaplet 。

如我所见，引用类型1.如果Snaplet是只读的，则有意义；而2.如果Snaplet需要更改，则有意义。

此外，当MySnaplet只能有一个SubSnaplet而没有更多时，为该方法提供一个类是有意义的，并且拥有绝对引用可能对像数据库这样的事情有意义，因为只有顶层Snaplet才有可能将其配置为组件。访问凭据，不可以。 但是，作为Snaplet编写器进行此假设可能是错误的，而使用相对引用也没有任何不利之处。

但是，这里有一个问题：现有的关于Hackack的Snaplet不符合我所做的这些假设； 上面提到的所有方法似乎都是随机使用的，并且在各种情况下都使用。 同样，我看不到上述其他方面的优点/缺点（例如是否需要Snaplet包装器）。

对我而言，引用类型2和方法1、2、5或6在所有情况下似乎都是最有意义的，而且我认为没有理由为什么始终仅使用（2，1）尚无共识。

所以：

作为Snaplet编写器，在编写新的Snaplet时（假定它具有通用性）应首选哪种方法，以及

究竟是为什么存在的所有Snaplets还没有使用相同的参考方法（即使是在核心的原因snap包，使用一吨的不同方法）？

Answer 1

TLDR; 大多数时候，您可能希望将with功能和相对镜头一起使用。

HasSubSnaplet类型类的使用是完全可选的模式，可以在没有多个SubSnaplet实例的情况下减少“ with subSnaplet”样板。 我们选择对snap软件包中随附的Heist snaplet进行此操作，因为这对于Heist snaplet有意义并为用户提供了模式示例。

由于类型类别是完全可选的，并且与镜头的选择大致正交，因此在本答案的其余部分中，我将重点介绍没有类型类别时该怎么做。

该API的目的是使用透镜（而不是“普通引用”来获取包裹在Snaplet数据类型中的东西）来访问状态。 这是因为在请求处理过程中更改状态是我们希望Snaplet提供的一项基本功能。 在大多数情况下，我们希望Snaplet成为不透明的包装，最终用户除了其Snaplet的状态类型外，无需触摸。 这就是为什么MonadState实例无需Snaplet包装器即可直接进入类型的原因。

话虽如此，有四种基本的访问模式。 我们可以在MonadSnaplet类型类中看到这些。

with     :: Lens     v       (Snaplet v') -> m b v' a -> m b v a
withTop  :: Lens     b       (Snaplet v') -> m b v' a -> m b v a
with'    :: Lens (Snaplet v) (Snaplet v') -> m b v' a -> m b v a
withTop' :: Lens (Snaplet b) (Snaplet v') -> m b v' a -> m b v a

前两个功能中包含的镜头图案是由TemplateHaskell的data-lens-template软件包自动为您生成的镜头，使用起来最自然。 因此，这是推荐的模式。 （因此使用较短的非素数名称。） with和withTop之间的区别在于with with相对透镜，而withTop带有绝对透镜。 大多数时候我都使用相对镜片。 但是我们希望允许使用绝对镜头，因为我可以想象复杂的应用程序，其中一个Snaplet可能需要获取另一个Snaplet提供的功能，但它不是当前Snaplet的后代。

有时在某些情况下您希望拥有身份识别镜。 这需要一个Lens (Snaplet a) (Snaplet b) 。 因此，后两个准备好的功能与前两个类似，不同之处在于它们采用了这种镜头。