将 JSON 对象转换为漂亮打印的 JSON 的 Angular 2 管道

IT技术 javascript json filter angular pipe
2021-03-05 21:01:56

尝试编写一个 Angular 2 管道,它将接受一个 JSON 对象字符串并将其返回打印/格式化以显示给用户。

例如,它将采用:

{ "id": 1, "number": "K3483483344", "state": "CA", "active": true }

并在 HTML 中显示时返回如下所示的内容:

在此处输入图片说明

所以在我看来,我可以有类似的东西:

<td> {{ record.jsonData | prettyprint }} </td>
5个回答

我想添加一种更简单的方法来做到这一点,使用内置json管道:

<pre>{{data | json}}</pre>

这样,格式被保留。

谢谢这是完美的!
2021-04-24 21:01:56
太明显了,我给了你一个观点,因为我为搜索它感到羞耻:p
2021-05-05 21:01:56
请检查我的答案以获得更漂亮的🙂
2021-05-08 21:01:56
凉爽的。请注意格式要求<pre>,不会如工作<p><span>等等。
2021-05-12 21:01:56
所以它是区分大小写的。:(
2021-05-17 21:01:56

我会为此创建一个自定义管道:

@Pipe({
  name: 'prettyprint'
})
export class PrettyPrintPipe implements PipeTransform {
  transform(val) {
    return JSON.stringify(val, null, 2)
      .replace(' ', '&nbsp;')
      .replace('\n', '<br/>');
  }
}

并以这种方式使用它:

@Component({
  selector: 'my-app',
  template: `
    <div [innerHTML]="obj | prettyprint"></div>
  `,
  pipes: [ PrettyPrintPipe ]
})
export class AppComponent {
  obj = {
    test: 'testttt',
    name: 'nameeee'
  }
}

请参阅此堆栈闪电战:https ://stackblitz.com/edit/angular-prettyprint

为什么这不是公认的分析仪?它回答了提出的问题,与接受的答案不同
2021-04-28 21:01:56
工作了!我有一个 json 字符串,而不是一个 json 对象,所以我只需要在调用 JSON.stringify 之前添加这一行: var jsonObject = JSON.parse(jsonString);
2021-05-02 21:01:56
你的失踪implements PipeTransformexport class PrettyPrintPipe
2021-05-08 21:01:56
意外的语法,我希望使用更像是使用标准管道: <div>{{obj | prettyprint }}</div> 但它有效!
2021-05-11 21:01:56
正如@shane-hsu 指出的那样,有一个内置json管道,就像在 Angular 1 中一样。
2021-05-20 21:01:56

由于这是谷歌上的第一个结果,让我快速总结一下:

  • 如果您只需要在没有正确格式的情况下打印 JSON json,Shane Hsu 建议的内置管道可以完美运行:<pre>{{data | json}}</pre>

  • 但是,如果您想要不同的输出,则需要按照 Thierry Templier 的建议创建自己的管道:

    1. ng g generate pipe prettyjson
    2. 在prettyjson.pipe.ts 中:
import { Pipe, PipeTransform } from '@angular/core';

@Pipe({
  name: 'prettyjson'
})
export class PrettyjsonPipe implements PipeTransform {

  transform(value: any, ...args: any[]): any {
    return JSON.stringify(value, null, 2)
    .replace(/ /g, '&nbsp;') // note the usage of `/ /g` instead of `' '` in order to replace all occurences
    .replace(/\n/g, '<br/>'); // same here
  }

}
  1. 最后,因为我们返回 HTML 内容,所以必须在innerHTML函数内部使用管道
<div [innerHTML]="data | prettyjson"></div>

我曾经需要这个场景,而且很多时候都需要它。我看到这个问题在 2021 年仍然很流行。所以我创建了一个详细的帖子,解释了如何不只是美化它,而是为它添加颜色,并构建了一个小工具来玩。

2021 解决方案: 我构建了自己的自定义管道版本(受此答案启发),它不仅可以美化,而且还可以像 vscode 一样为 JSON 添加颜色我不使用内置的 JSON 管道,因为它不能满足我的全部目的。

如果您愿意,这也使您可以自由添加数字行和填充。即使使用嵌套的 jsons 也要尝试一下!

示例输出如下

演示

全局样式表应包含根据您的主题的颜色,例如 styles.scss

pre {
  font-weight: 400;

  .number-line {
    color: #adadaf;
  }
  .string {
    color: #95c602;
  }
  .number {
    color: #f2b619;
  }
  .boolean {
    color: #0097f1;
  }
  .null {
    color: #727990;
  }
  .key {
    color: #fff;
  }
}

管道的源代码

@Pipe({
  name: 'prettyjson',
  pure:true
})
export class PrettyJsonPipe implements PipeTransform {
  transform(value: any, args: any[]): any {
    try {
      /**
       * check and try to parse value if it's not an object
       * if it fails to parse which means it is an invalid JSON
       */
      return this.applyColors(
        typeof value === 'object' ? value : JSON.parse(value),
        args[0],
        args[1]
      );
    } catch (e) {
      return this.applyColors({ error: 'Invalid JSON' }, args[0], args[1]);
    }
  }

  applyColors(obj: any, showNumebrLine: boolean = false, padding: number = 4) {
    // line number start from 1
    let line = 1;

    if (typeof obj != 'string') {
      obj = JSON.stringify(obj, undefined, 3);
    }

    /**
     * Converts special charaters like &, <, > to equivalent HTML code of it
     */
    obj = obj.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
    /* taken from https://stackoverflow.com/a/7220510 */

    /**
     * wraps every datatype, key for e.g
     * numbers from json object to something like
     * <span class="number" > 234 </span>
     * this is why needed custom themeClass which we created in _global.css
     * @return final bunch of span tags after all conversion
     */
    obj = obj.replace(
      /("(\\u[a-zA-Z0-9]{4}|\\[^u]|[^\\"])*"(\s*:)?|\b(true|false|null)\b|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?)/g,
      (match: any) => {
        // class to be applied inside pre tag
        let themeClass = 'number';
        if (/^"/.test(match)) {
          if (/:$/.test(match)) {
            themeClass = 'key';
          } else {
            themeClass = 'string';
          }
        } else if (/true|false/.test(match)) {
          themeClass = 'boolean';
        } else if (/null/.test(match)) {
          themeClass = 'null';
        }
        return '<span class="' + themeClass + '">' + match + '</span>';
      }
    );

    /**
     * Regex for the start of the line, insert a number-line themeClass tag before each line
     */
    return showNumebrLine
      ? obj.replace(
          /^/gm,
          () =>
            `<span class="number-line pl-3 select-none" >${String(line++).padEnd(padding)}</span>`
        )
      : obj;
  }
}

现在像这样在 HTML 中传递这些参数。如果你不通过它默认值为showNumberlinefalse 并且padding是 4

<pre [innerHTML]="dummyJsonObject | prettyjson: [true, 3]"></pre>

希望这有帮助🙂

由于我的变量是与 ngModel 绑定的两种方式,因此我无法在 html 上执行此操作。我在组件端使用JSON.stringify(displayValue, null, 2) ,它完成了工作。