vue（element）中使用codemirror实现代码高亮，代码补全，版本差异对比

Posted 2021-02-28

vue（element）中使用codemirror实现代码高亮，代码补全，版本差异对比

使用的是vue语言，用element的组件，要做一个在线编辑代码，要求输入代码内容，可以进行高亮展示，可以切换各不同语言，而且支持关键字补全，还要有一个各不同版本间的代码左右比较，这就是需求。

至于为什么选中codemirror，请查看vue（element）中代码高亮插件全面对比

好了，现在正式开工吧！

首先需要下载codemirror组件，diff-match-patch组件

npm install codemirror
npm install diff-match-patch

当然啦，npm下载很是缓慢，换个国内镜像，淘宝的吧。果然，速度就嗖嗖的起来。

npm install -g cnpm --registry=https://registry.npm.taobao.org
cnpm install

cnpm install codemirror
cnpm install diff-match-patch

可在node_modules下看到其目录结构

核心代码如下，简练易懂，可以根据下面的自己在接着定制开发。

<template>
  <div>
    <!-- 操作按钮 --> 
    <el-button @click="handleAdd">代码编辑，高亮补全</el-button>
    <el-button @click="handleMerge">代码版本，差异对比</el-button>

    <!-- 代码编辑，高亮补全 对话框内容 -->  
    <el-dialog :title="title" :visible.sync="open">
      <el-form ref="form" :model="form" label-width="80px">
        <el-form-item label="脚本内容">
          <div class="in-coder-panel">
            <textarea ref="textarea"></textarea>
            <el-select class="code-mode-select" v-model="mode" @change="changeMode">
              <el-option v-for="mode in modes" :key="mode.value" :label="mode.label" :value="mode.value">
              </el-option>
            </el-select>
          </div>
        </el-form-item>
      </el-form>
    </el-dialog>

    <!-- 代码版本，差异对比 对话框内容 -->
    <el-dialog :title="titleBBB" :visible.sync="openBBB">
      <div id="view"></div>
    </el-dialog>

  </div>
</template>

<script>
  // 引入全局实例
  import CodeMirror from ‘codemirror‘
  // 核心样式
  import ‘codemirror/lib/codemirror.css‘
  // 引入主题后还需要在 options 中指定主题才会生效
  import ‘codemirror/theme/idea.css‘

  // 需要引入具体的语法高亮库才会有对应的语法高亮效果
  // codemirror 官方其实支持通过 /addon/mode/loadmode.js 和 /mode/meta.js 来实现动态加载对应语法高亮库
  // 但 vue 貌似没有无法在实例初始化后再动态加载对应 JS ，所以此处才把对应的 JS 提前引入
  import ‘codemirror/mode/javascript/javascript.js‘
  import ‘codemirror/mode/css/css.js‘
  import ‘codemirror/mode/xml/xml.js‘
  import ‘codemirror/mode/shell/shell.js‘
  import ‘codemirror/mode/sql/sql.js‘

  //代码补全提示
  import ‘codemirror/addon/hint/anyword-hint.js‘;
  import ‘codemirror/addon/hint/css-hint.js‘;
  import ‘codemirror/addon/hint/html-hint.js‘;
  import ‘codemirror/addon/hint/javascript-hint.js‘;
  import ‘codemirror/addon/hint/show-hint.css‘;
  import ‘codemirror/addon/hint/show-hint.js‘;
  import ‘codemirror/addon/hint/sql-hint.js‘;
  import ‘codemirror/addon/hint/xml-hint.js‘;

  //代码版本差异比较
  import ‘codemirror/addon/merge/merge.js‘
  import ‘codemirror/addon/merge/merge.css‘
  import DiffMatchPatch from ‘diff-match-patch‘

  window.diff_match_patch = DiffMatchPatch
  window.DIFF_DELETE = -1
  window.DIFF_INSERT = 1
  window.DIFF_EQUAL = 0

  export default {
    name: "Code",

    props: {
      // 外部传入的内容，用于实现双向绑定
      value: String,
      // 外部传入的语法类型
      language: {
        type: String,
        default: null
      }
    },

    data() {
      return {
        // 内部真实的内容
        code: ‘#!/bin/bash
‘ +
        ‘cd /root/
‘ +
        ‘list=(`ls`)
‘ +
        ‘ 
‘ +
        ‘for i in ${list[@]}
‘ +
        ‘do
‘ +
        ‘   if [ -d $i ]
‘ +
        ‘   then
‘ +
        ‘       cp -r $i /tmp/
‘ +
        ‘   fi
‘ +
        ‘done‘,
        // 默认的语法类型
        mode: ‘shell‘,
        // 编辑器实例
        coder: null,
        // 默认配置
        options: {
          // 缩进格式
          tabSize: 4,
          // 主题，对应主题库 JS 需要提前引入
          theme: ‘idea‘,
          // 显示行号
          lineNumbers: true,
          line: true,
          extraKeys: {"Ctrl": "autocomplete"},
        },
        // 支持切换的语法高亮类型，对应 JS 已经提前引入
        // 使用的是 MIME-TYPE ，不过作为前缀的 text/ 在后面指定时写死了
        modes: [{
          value: ‘css‘,
          label: ‘CSS‘
        }, {
          value: ‘javascript‘,
          label: ‘Javascript‘
        }, {
          value: ‘html‘,
          label: ‘XML/HTML‘
        },  {
          value: ‘x-sh‘,
          label: ‘Shell‘
        }, {
          value: ‘x-sql‘,
          label: ‘SQL‘
        }],
        // 弹出层标题
        title: "",
        titleBBB: "",
        // 是否显示弹出层
        open: false,
        openBBB: false,
    },

    methods: {
      // 初始化
      _initialize() {
        // 初始化编辑器实例，传入需要被实例化的文本域对象和默认配置
        this.coder = CodeMirror.fromTextArea(this.$refs.textarea, this.options)
        // 编辑器赋值
        this.coder.setValue(this.value || this.code)

        // 支持双向绑定
        this.coder.on(‘change‘, (coder) => {
          this.code = coder.getValue()

          if (this.$emit) {
            this.$emit(‘input‘, this.code)
          }
        })

        // 尝试从父容器获取语法类型
        if (this.language) {
          // 获取具体的语法类型对象
          let modeObj = this._getLanguage(this.language)

          // 判断父容器传入的语法是否被支持
          if (modeObj) {
            this.mode = modeObj.label
          }
        }
      },
      // 获取当前语法类型
      _getLanguage(language) {
        // 在支持的语法类型列表中寻找传入的语法类型
        return this.modes.find((mode) => {
          // 所有的值都忽略大小写，方便比较
          let currentLanguage = language.toLowerCase()
          let currentLabel = mode.label.toLowerCase()
          let currentValue = mode.value.toLowerCase()

          // 由于真实值可能不规范，例如 java 的真实值是 x-java ，所以讲 value 和 label 同时和传入语法进行比较
          return currentLabel === currentLanguage || currentValue === currentLanguage
        })
      },
      // 更改模式
      changeMode(val) {
        // 修改编辑器的语法配置
        this.coder.setOption(‘mode‘, `text/${val}`)

        // 获取修改后的语法
        let label = this._getLanguage(val).label.toLowerCase()

        // 允许父容器通过以下函数监听当前的语法值
        this.$emit(‘language-change‘, label)
      },

      initUI(value, orig) {
        if (value == null) return;
        let target = document.getElementById("view");
        target.innerHTML = "";
        CodeMirror.MergeView(target, {
          value: value,//上次内容
          origLeft: null,
          orig: orig,//本次内容
          lineNumbers: true,//显示行号
          mode: "shell",
          highlightDifferences: true,
          styleActiveLine: true,
          matchBrackets: true,
          connect: ‘align‘,
          readOnly: true,//只读 不可修改
        });
      },

      /** 按钮操作 */
      handleAdd() {
        this.open = true;
        this.title = "代码编辑，高亮补全";

        this.$nextTick(function () {
          this._initialize();
        });

      },

      /** 按钮操作 */    
      handleUpdateBBB() {
        this.openBBB = true;
        this.titleBBB = "代码版本，差异对比";

        // 初始化版本差异
        this.$nextTick(function () {
          this.initUI("#!/bin/bash
" +
            "ip="123.21.12.11"
" +
            "email="lgx@example"
" +
            " 
" +
            "while 1
" +
            "do
" +
            "  ping -c10 $ip > /dev/null 2>/dev/null
" +
            "  if [ $? != "0" ]
" +
            "  then
" +
            "       # 调用一个用于发邮件的脚本
" +
            "     python /usr/local/sbin/mail.py $email "$ip down" "$ip is down"
" +
            "  fi
" +
            "  sleep 30
" +
            "done", "#!/bin/bash
" +
            "ip="123.21.12.11"
" +
            "email="admin@example"
" +
            " 
" +
            "while 1
" +
            "do
" +
            "  ping -c10 $ip > /dev/null 2>/dev/null
" +
            "  if [ $? != "0" ]
" +
            "  then
" +
            "       # 调用一个用于发邮件的脚本
" +
            "     python /usr/local/sbin/mail.py $email "$ip down" "$ip is down"
" +
            "  fi
" +
            "done")
        });
      },    

    }
  };
</script>

<style lang="stylus" rel="stylesheet/stylus">
  .in-coder-panel
    flex-grow 1
    display flex
    position relative

    .CodeMirror
      flex-grow 1
      z-index 1
      .CodeMirror-code
        line-height 19px

    .code-mode-select
      position absolute
      z-index 2
      right 10px
      top 10px
      max-width 130px
</style>

运行后，代码高亮效果如下所示；

运行后，代码自动补全效果类上，我绑定的是 Ctrl 键，输入关键字的前几个字母，按住Ctrl键，即可根据所选语言自动补全；

运行后，代码版本差异对比效果如下所示；

滚动任一一侧的纵向滚动条或横向滚动条，另一侧的也会跟着幅度动起来。