Fetchr 项目使用教程

Fetchr 项目使用教程

fetchr Universal data access layer for web applications. 项目地址: https://gitcode.com/gh_mirrors/fe/fetchr

1. 项目目录结构及介绍

Fetchr 是一个为 web 应用程序提供通用数据访问层的开源项目。以下是项目的目录结构及各部分的简要介绍：

fetchr/
├── .github/             # GitHub 仓库配置文件
├── docs/                # 项目文档
├── examples/            # 使用示例
├── libs/                # Fetchr 核心库代码
├── tests/               # 测试用例
├── .editorconfig         # 编辑器配置文件
├── .eslintignore         # ESLint 忽略文件
├── .eslintrc.js          # ESLint 配置文件
├── .gitignore            # Git 忽略文件
├── .npmignore            # npm 忽略文件
├── .prettierignore       # Prettier 忽略文件
├── CONTRIBUTING.md       # 贡献指南
├── LICENSE.md            # 许可证文件
├── README.md             # 项目说明文件
├── package-lock.json     # npm 包锁定文件
└── package.json          # npm 包配置文件

2. 项目的启动文件介绍

项目的启动主要涉及到 libs 目录下的 Fetcher.js 文件，这是 Fetchr 的核心库文件。以下是启动 Fetchr 的基本步骤：

• 在服务端，需要将 Fetchr 的中间件添加到 Express 应用中，并确保在使用 Fetchr 中间件之前使用了 body-parser 中间件。
• 在客户端，需要创建一个 Fetcher 实例，并配置 xhrPath 选项以匹配服务端中间件的挂载路径。

// 服务端启动示例
import express from 'express';
import Fetcher from 'fetchr';
import bodyParser from 'body-parser';

const app = express();

// 使用 bodyParser 中间件
app.use(bodyParser.json());

// 挂载 Fetchr 中间件
app.use('/myCustomAPIEndpoint', Fetchr.middleware());

// 启动服务器
app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

3. 项目的配置文件介绍

Fetchr 的配置主要通过 Fetcher 实例化时传递的选项来进行。以下是一些主要配置项的介绍：

• xhrPath: 客户端用于与服务端通信的 API 端点路径。
• req: 服务端每个请求都会传递的 req 对象，允许数据服务访问当前请求的信息。

// 客户端配置示例
const fetcher = new Fetcher({
  xhrPath: '/myCustomAPIEndpoint'
});

// 服务端配置示例
app.use('/myCustomAPIEndpoint', Fetcher.middleware());
app.use((req, res, next) => {
  const fetcher = new Fetcher({
    xhrPath: '/myCustomAPIEndpoint',
    req: req
  });
  // 使用 fetcher 进行数据操作
  next();
});

Fetchr 还允许注册数据服务，这些服务定义了资源以及对应的 CRUD 操作。注册服务后，可以通过 Fetcher 实例来调用这些操作。

以上就是 Fetchr 项目的目录结构、启动文件和配置文件的简要介绍。在实际使用中，还需要根据具体需求调整配置并进行相应的开发工作。

fetchr Universal data access layer for web applications. 项目地址: https://gitcode.com/gh_mirrors/fe/fetchr