AdonisJS at a glance

本章节旨在给出框架的鸟瞰视角，让你对创建 AdonisJS 应用有一个初步的了解。

当你准备好去写项目时，可以直接进入技术指南。

AdonisJS是一个后端框架。它能帮助你创建以数据驱动的动态 Web 应用。

使用AdonisJS，你可以处理 HTTP 请求、查询数据库、用户验证、上传文件、发送 Email 等内容。

如果你曾经使用过其他后端框架比如Rails、Laravel或Django,你就可以把 AdonisJS 看成是同一类的框架。

用 routes 创建路由

你能使用 routes （即路由）模块定义 URL。

你可以把 routes 看成是 URL 和 JavaScript 函数间的映射，当用户访问该 URL 时，就能执行路由上的 JavaScript。

js
1import Route from '@ioc:Adonis/Core/Route'
2
3Route.get('/', () => {
4  return 'Hello! This is the homepage of my new app'
5})

上面的代码定义了一个静态的路由。然而，数据驱动的应用往往需要一种能注册动态路由的能力。举个例子：利用 URL 上的 id 来查询数据库。

js
1import Route from '@ioc:Adonis/Core/Route'
2import Database from '@ioc:Adonis/Lucid/Database'
3
4Route.get('posts/:id', ({ params }) => {
5  return Database.from('posts').select('*').where('id', params.id).first()
6})

用 Controller 处理请求

在 AdonisJS 中，Controller（控制器）是一种处理网络请求的事实标准方法，它们帮助您从路由文件中提取所有内联函数调用到专用的控制器文件中，并保持您的路由文件整洁。

第一步：创建控制器

bash
1node ace make:controller Posts

第二步：实现所需要的请求处理方法

js
1  import Database from '@ioc:Adonis/Lucid/Database'
2
3  export default class PostsController {
4    public async show({ params }) {
5      return Database
6        .from('posts')
7        .select('*')
8        .where('id', params.id)
9        .first()
10    }
11  }

第三步：在路由上注册

js
1Route.get('posts/:id', 'PostsController.show')

用 ORM 查询数据库

你能使用官方的 ORM 库- Lucid 来与 SQL 数据库进行交互。Lucid 具有丰富的 API，可执行模式迁移、使用 JavaScript API 构建 SQL 查询以及为数据库添加虚拟数据。

更重要的是，Lucid 在活动记录模式的基础上构建了数据模型。您可以按如下方式创建和使用模型：

创建一个新的模型

bash
1node ace make:model Post

配置列信息

js
1  import { column, BaseModel } from '@ioc:Adonis/Lucid/Orm'
2
3  export default class Post extends BaseModel {
4    @column({ isPrimary: true })
5    public id: number
6
7    @column()
8    public title: string
9
10    @column()
11    public description: string
12  }

在控制器中引入并使用它们

js
1  import Post from 'App/Models/Post'
2
3  export default class PostsController {
4    public async show({ params }) {
5      const post = await Post.find(1)
6      return post
7    }
8  }

用 templates 渲染 HTML

AdonisJS 附带一个自主开发的模版引擎——Edge.Edge支持布局、部分渲染、条件语句、循环等。但最耀眼的是 edge 的组件系统。

创建 View 模板

bash
1  node ace make:view posts/index

书写标记

html
1<div class="article">
2  <h1>{{ post.title }}</h1>
3  <p>{{ post.description }}</p>
4</div>

在控制器中渲染模板

js
1  import Post from 'App/Models/Post'
2
3  export default class PostsController {
4    public async show({ params, view }) {
5      const post = await Post.find(1)
6      return view.render('posts/index', { post })
7    }
8  }

用 auth package 鉴权

AdonisJS 支持各种身份鉴权系统，满足传统的 Web App 和 API Servers 的需要。在鉴权守卫（guard）的帮助下，您可以使用基于 session（会话）的登录或创建用于无状态身份验证的 API 令牌。

按照和设置 auth package

bash
1  npm i @adonisjs/auth
2
3  node ace configure @adonisjs/auth

使用 session 登录

js
1  export default class AuthController {
2    public async login({ request, auth, response }) {
3      const email = request.input('email')
4      const password = request.input('password')
5
6      await auth
7        .use('web') // 👈 using sessions guard
8        .attempt(email, password)
9
10      response.redirect().toRoute('dashboard')
11    }
12  }

或者生成 API 令牌（Token）替代 session

js
1  export default class AuthController {
2    public async login({ request, auth }) {
3      const email = request.input('email')
4      const password = request.input('password')
5
6      const token = await auth
7        .use('api') // 👈 using API guard
8        .attempt(email, password)
9
10      return token
11    }
12  }

用 validator 校验

将 validators 作为第一道防线以保护应用不受无效数据或者缺失数据的影响。

未能满足验证规则的请求将被重定向回表单，并显示正确的错误消息。反之，您可以使用正确的数据类型访问已验证的值。

创建 validator

bash
1  node ace make:validator CreatePost

定义 validation schema

js
1  import { schema, rules } from '@ioc:Adonis/Core/Validator'
2  import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext'
3
4  export default class CreatePostValidator {
5    constructor (protected ctx: HttpContextContract) {
6    }
7
8    public schema = schema.create({
9      title: schema.string(),
10      description: schema.string({}, [
11        rules.escape()
12      ]),
13    })
14  }

验证请求

js
1  import CreatePost from 'App/Validators/CreatePostValidator'
2
3  export default class PostsController {
4    public async store({ request }) {
5      const post = await request.validate(CreatePost)
6      console.log(post.title)
7      console.log(post.description)
8    }
9  }

用 webpack encore 编译资源

在某个时间点，你可能需要使用 CSS 框架并希望添加一些 JavaScript 使你的 Web 应用程序具有交互性。

根据今天的标准，CSS 和前端 JavaScript 在传输到浏览器之前需要进行转译和压缩。这个打包过程并不简单，因此你必须使用打包工具。

AdonisJS 使用合理的默认设置预配置了 Webpack（一个行业标准的打包工具），这样你就不必浪费时间调整它的参数。

配置 webpack encore

bash
1  node ace configure encore

启动开发服务器

bash
1  node ace serve --watch
2
3  # Serve command starts both
4  # ✅ The AdonisJS HTTP server
5  # ✅ And the Webpack dev server

构建生产环境

bash
1  node ace build --production
2
3  # Build commands compile both
4  # ✅ The AdonisJS Typescript source to JavaScript
5  # ✅ And the frontend assets using Webpack