序列化

Summer 自动序列化返回数据.

控制器方法如果返回的是一个对象体，Summer会将其序列化成JSON字符串，并且设置头部类型为application/json。字符串或其他 Javascript 基础类型会被序列号成字符串，返回的头部会设置成 text/html 类型。

枚举会转换成字符串 key 值。

import { Controller, Get } from '@summer-js/summer'

enum Direction {
  UP = 0,
  DOWN = 1,
  LEFT = 2,
  RIGHT = 3
}

class Resource { 
  info: string
  direction: Direction
}

@Controller
export class SerializationController {
  @Get('/serialize')
  async serialize() {
    const r = new Resource()
    r.direction = Direction.LEFT
    r.info = "Information"
    return r
  }
}

Output

{
    "info":"Information",
    "direction":"LEFT"
}

使用 @Serialize() 序列化数据

import { Controller, Get, Serialize } from '@summer-js/summer'

class User {
  name: string
  @Serialize((value: string) => value.replace(/.+/g, '*****'))
  password: string
  gender: Gender
}

@Controller
export class SerializationController {

  @Get('/user')
  async propSerialize() {
    const user = new User()
    user.name = 'John'
    user.password = 'my-password'
    user.gender = Gender.Male
    return user
  }

}

Output

{
    "name": "John",
    "password": "*****",
    "gender": "Male"
}

使用 @Ignore 隐藏字段

提醒

也可以使用 @Serialize() 返回 undefined 隐藏字段

import { Controller, Get, Ignore } from '@summer-js/summer'

enum Gender {
  Male,
  Female
}

class User {
  name: string
  @Ignore
  password: string
  gender: Gender
}

@Controller
export class SerializationController {

  @Get('/user')
  async propSerialize() {
    const user = new User()
    user.name = 'John'
    user.password = 'my-password'
    user.gender = Gender.Male
    return user
  }

}

Output

{
    "name": "John",
    "gender": "Male"
}