使用LoopBack快速开发简单的数据库CRUD

1. LoopBack简介

网站:https://loopback.io/doc/index.html
我们都知道Express是一个基于Node.js的web开发框架,但是它只是一个保持最小规模的框架,这意味着它只实现了基本的web server的功能和扩展点。实际应用的话还需要额外的框架或中间件的帮助。Express的文档中介绍数据库的支持的时候推荐了LoopBack,这是一个基于express和nodejs的框架,致力于提供一个易扩展的REST API的脚手架,写很少代码就可以实现CRUD这样的REST API的功能。它还支持GraphQL。
在这里插入图片描述

2. 开发环境准备

  • Node JS - 运行环境,必选
  • Express - 基础框架,必选
  • LoopBack - 使用 npm 安装: npm install -g @loopback/cli
  • MySQL - 数据库,可选

3. 使用LoopBack

3.1开发步骤

安装好loopback 的命令行工具后就可以使用了。

3.1.1 生成APP项目

lb4 app

随后它会询问你一系列问题诸如项目名称,描述,根目录,入口类名之类,一一回答即可。当然你也可以在在上面命令的基础上加上参数就不用回答这些问题了。

3.1.2 生成model

这一步非必须,但我们要用数据库的话还是得生成对应的model。可以用如下命令来生成model:

lb4 model [options] [<name>]

但我们经常面对的问题是已经有现成的数据库和表了,并非全新定义。针对这种情况loopback 提供了discovery(发现)的机制,可以从已有的数据库中读取和选择表定义来生成对应的model。
这时候你得先定义一个数据源:

lb4 datasource

它会询问你数据库地址,用户密码等信息然后为你建立好数据源。和上面一样,自己手动加参数也行,就不会再询问了。
有了数据源后,先编译一下npm run build,否则找不到数据源。然后执行discover命令来扫描数据库生成model:

lb4 discover

接下来它会询问你要用哪个数据源,列出所有表让你选择,然后对应选中的表生成model。
生成model以后,还得生成repository才能用。

lb4 repository

3.1.3 生成controller

因为loopback是生成web API的框架,所以没有view层,controller就是对外接口了。以下命令可以生成controller

lb4 controller

运行时它会询问你要一个普通的controller还是要一个支持数据库CRUD的controller。
如果是CRUD的,就会让你选择用哪个repository(对应于某个model以及背后的数据库表)。
如果是普通的就要自己往里面添加响应代码了。

3.1.4 编译运行

直接在项目根目录下执行npm start即可启动服务器。默认的主页很简单,点击里面的链接可以看到目前支持的API定义,包括给机器阅读的json格式和给人看的网页表格版。
如果你仅仅想编译一下npm run build即可。
在这里插入图片描述

在这里插入图片描述

3.1.5 添加友善的前端

上面生成的服务器只有rest API可用,如果想要GUI用户界面还是得自己写。比如我们用react 写一个单页应用,来调用这些API交互。这些前端网页和JS代码对于loopback server而言只是静态资源而已(因为即使是代码也是运行在客户端浏览器中的)写好了放到public文件夹即可。

3.2 踩坑记录

  • 执行discover前需要定义data source并编译一下
  • 如果删除了不想要的代码,最好npm run clean一下否则有可能仍然运行不过
  • 如果想生成ralation, 生成之前需要建好repository。如果遇到这样的错误:“Target model primary key does not exist.”。只要把model中@property部分的id:1手动改成id:true就可以了。如果遇到这样的错误:“Property ‘Number’ does not exist on type…"。要把相应的controller里面Number 改成number。
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章