开源项目 `router.cr` 使用教程

开源项目 router.cr 使用教程

router.crMinimum High Performance Middleware for Crystal Web Server.项目地址:https://gitcode.com/gh_mirrors/ro/router.cr

1. 项目的目录结构及介绍

router.cr 项目的目录结构如下：

router.cr/
├── src/
│   └── Class.cr
├── LICENSE
├── README.md
├── shard.yml

目录结构介绍

• src/: 包含项目的主要源代码文件。
  • Class.cr: 主要的类定义文件，包含路由处理逻辑。
• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• shard.yml: 项目的依赖配置文件。

2. 项目的启动文件介绍

项目的启动文件位于 src/Class.cr。以下是启动文件的主要内容：

require "http/server"

module Server
  class Base
    def initialize
      @router = [] of String => (-> String)
    end

    def run(int port)
      server = HTTP::Server.new do |ctx|
        req = ctx.request
        if @router.has_key?(req.path.to_s)
          ctx.response.respond_with_status(200, @router[req.path.to_s].call)
        else
          ctx.response.respond_with_status(401, "Not found, please return to the root path /")
        end
      end
      server.listen(port)
    end

    def process(router, &block : (-> String))
      @router[router.to_s] = block
    end
  end
end

启动文件介绍

• initialize: 初始化路由表。
• run: 启动HTTP服务器，监听指定端口，并根据路由表处理请求。
• process: 定义路由处理逻辑。

3. 项目的配置文件介绍

项目的配置文件是 shard.yml，它定义了项目的依赖和其他配置信息。以下是 shard.yml 的内容示例：

name: router
version: 0.1.0

dependencies:
  router:
    github: tbrand/router.cr

配置文件介绍

• name: 项目名称。
• version: 项目版本。
• dependencies: 项目依赖，这里指定了 router.cr 的GitHub仓库地址。

以上是 router.cr 项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助你更好地理解和使用该项目。

router.crMinimum High Performance Middleware for Crystal Web Server.项目地址:https://gitcode.com/gh_mirrors/ro/router.cr