npm 包 egg-born-starter-front-backend-mysql 使用教程

阅读时长 7 分钟读完

背景

在前端开发中,我们通常需要用到后端的支持,而使用 egg.js 可以极大的提升开发效率,而 egg-born-starter-front-backend-mysql 是一个基于 egg.js 的脚手架,用于快速构建前后端分离的 web 应用,并且支持使用 MySQL 数据库进行数据存储。

安装 egg-born-starter-front-backend-mysql

在使用 egg-born-starter-front-backend-mysql 之前,需要先安装 egg.js 和 MySQL 数据库。

首先,我们需要在项目根目录下执行以下命令,创建一个 egg 项目:

接着,进入该项目目录,执行以下命令安装 egg-born-starter-front-backend-mysql:

配置 egg-born-starter-front-backend-mysql

在项目根目录下,打开 config/config.default.js 文件,在 config 中加入以下配置:

-- -------------------- ---- -------
------------- - -
  ------------------ -
    ------- -----
    -------- ---------------------------------------
  --
  ------ -
    ------- -----
    -------- ------------
  --
--

这里将 egg-born-starter-front-backend-mysqlegg-mysql 集成到 egg 项目中。

接下来,我们需要在 config/config.local.js 文件中配置 MySQL 数据库连接信息:

-- -------------------- ---- -------
------------- - -
  ------- -
    ----- ------------
    ----- -------
    ----- -------
    --------- ---------
    --------- -------
  --
  ---- -----
  ------ ------
--

在这里,我们将数据库连接信息配置为本地 MySQL 数据库。

引入 egg-born-starter-front-backend-mysql

在使用 egg-born-starter-front-backend-mysql 之前需要先引入,这里我们在 app.js 中引入该插件:

现在,我们已经成功的集成了 egg-born-starter-front-backend-mysql 插件到我们的 egg 项目中。

使用 egg-born-starter-front-backend-mysql

现在,我们已经完成了插件的集成,我们可以通过 egg-born-starter-front-backend-mysql 来快速搭建一个前后端分离的 web 应用。

创建 controller

app/controller/ 目录下创建一个 example.js 文件,这里我们以一个简单的示例来演示如何通过 egg-born-starter-front-backend-mysql 来进行数据的增删改查操作。

-- -------------------- ---- -------
-------------- - --- -- -
  ------ ----- ------- ------- -------------- -
    ----- ------- -
      ----- - --- - - -----
      ----- ---- - ----- ----------------------------
      ------------------
    -

    ----- -------- -
      ----- - --- - - -----
      ----- - ---- - - -----------------
      ----- ---- - ----- ---------------------------- ---- ---
      ----------------- -----
    -

    ----- -------- -
      ----- - --- - - -----
      ----- - --- ---- - - -----------------
      ----- ---- - ----- ------------------------------ - ---- ---
      ------------------
    -

    ----- --------- -
      ----- - --- - - -----
      ----- - -- - - -----------
      ----- --------------------------------
      ---------- - ----
    -
  --
--

创建 service

app/service/ 目录下创建一个 example.js 文件,这里我们用来处理数据的增删改查操作。

-- -------------------- ---- -------
-------------- - --- -- -
  ----- ------- ------- ----------- -
    ----- ------- -
      ----- - ----- - - ---------
      ----- ---- - ----- ------------------------
      ------ -
        -----
      --
    -

    ----- ------------ -
      ----- - ----- - - ---------
      ----- ------ - ----- ----------------------- - ---- ---
      ------ -
        --- ----------------
        -----
      --
    -

    ----- ---------- ----- -
      ----- - ----- - - ---------
      ----- ----------------------- - ---- -- - ------ - -- - ---
      ------ -
        ---
        -----
      --
    -

    ----- ----------- -
      ----- - ----- - - ---------
      ----- ----------------------- - -- ---
    -
  -
  ------ --------
--

创建 model

app/model/ 目录下创建一个 example.js 文件,这里我们用来定义数据表结构。

-- -------------------- ---- -------
-------------- - --- -- -
  ----- - -------- ------ - - --------------
  ----- ------- - --------------------------- -
    --- -
      ----- --------
      ----------- -----
      -------------- -----
    --
    ----- -
      ----- -------
    --
  ---
  ------ --------
--

创建路由

app/router.js 中添加以下路由:

小结

在本文中,我们学习了使用 egg-born-starter-front-backend-mysql 这个 npm 包来进行前后端分离应用的开发,通过示例代码帮助大家更好的理解和使用该插件。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005607381e8991b448de9cf

纠错
反馈