【Haskell与Scotty框架实战】搭建全栈应用——实操指南

【Haskell与Scotty框架实战】搭建全栈应用——实操指南

haskell-scotty-realworld-example-app Exemplary real world backend API built with Haskell/Scotty https://realworld.io 项目地址: https://gitcode.com/gh_mirrors/ha/haskell-scotty-realworld-example-app

本教程将引导您深入了解并部署一个基于Haskell与Scotty框架的全功能后端API示例项目——haskell-scotty-realworld-example-app。这个项目遵循RealWorld规范，集成了CRUD操作、认证、路由、分页等核心后端功能。

1. 项目目录结构及介绍

项目结构精心设计以支持清晰的模块化开发：

• app: 应用程序的主要入口点，包含处理业务逻辑的Haskell文件。
• test: 测试套件所在目录，确保代码质量。
• src: 主要的源代码存放区域，包括应用的核心逻辑。
• postgresql: 数据库迁移脚本，用于设置和更新数据库结构。
• secrets: 存储默认的开发环境配置文件如HTTPS和JWT签名文件（在生产环境中务必替换）。
• scripts: 提供便利的开发辅助脚本，比如自动重启服务器或测试。
• .gitignore, Setup.hs, package.yaml, stack.yaml: 版本控制、构建设置与依赖管理相关文件。
• LICENSE, README.md: 许可证信息和项目快速入门指南。

2. 项目的启动文件介绍

主要的启动文件是通过Haskell编写的，位于**app/Main.hs**或者按照Haskell项目的常规约定，在执行命令时被指定的入口点。虽然直接指定文件可能不是必需的，因为项目通常通过stack exec <executable-name>来启动，其中<executable-name>通常是realworld-exe，这是由stack根据package.yaml中的配置自动生成的。

启动应用程序的命令示例如下:

stack exec realworld-exe

对于开发模式，可以使用提供的脚本来监控文件更改并自动重启服务器:

./scripts/dev.sh

3. 项目的配置文件介绍

配置主要通过环境变量进行管理，但具体的开发配置和默认值可以在**secrets**目录下的文件中找到。这些默认配置主要用于开发环境，且强烈建议在部署到生产环境前替换为安全有效的配置。例如，DATABASE_URL定义了数据库连接字符串，而JWT_SECRET存储JSON Web Token的加密密钥。

此外，项目的核心配置元数据，如依赖项版本和构建指令，被指定在两个关键的配置文件中：

• stack.yaml: 控制Haskell项目的依赖管理和编译选项。它包含了如何构建项目、使用的resolver（如Stackage夜版）、额外的栈配置等。

• package.yaml: 定义了项目的名称、版本、作者、许可信息以及Haskell模块的入口点，还有项目的依赖列表。

为了自定义或调整运行时行为，关注环境变量的设置尤为重要，具体变量及其描述可在项目文档或源码注释中找到。

快速上手步骤概览

1. 安装先决条件：确保已安装Haskell Stack和PostgreSQL。
2. 克隆仓库：

   git clone https://github.com/eckyputrady/haskell-scotty-realworld-example-app.git
   

3. 初始化环境：

   cd haskell-scotty-realworld-example-app
   stack setup
   

4. 构建与运行：

   stack build
   stack exec realworld-exe
   

或使用开发者模式自动重载：

./scripts/dev.sh

通过遵循以上步骤，您可以轻松地探索和运行这个全栈Haskell应用示例，体验Haskell在构建复杂Web服务方面的强大能力。

haskell-scotty-realworld-example-app Exemplary real world backend API built with Haskell/Scotty https://realworld.io 项目地址: https://gitcode.com/gh_mirrors/ha/haskell-scotty-realworld-example-app