vue（element）中使用codemirror實現代碼高亮，代碼補全，版本差異對比

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\n' +
        'cd /root/\n' +
        'list=(`ls`)\n' +
        ' \n' +
        'for i in ${list[@]}\n' +
        'do\n' +
        '   if [ -d $i ]\n' +
        '   then\n' +
        '       cp -r $i /tmp/\n' +
        '   fi\n' +
        '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\n" +
            "ip=\"123.21.12.11\"\n" +
            "email=\"lgx@example\"\n" +
            " \n" +
            "while 1\n" +
            "do\n" +
            "  ping -c10 $ip > /dev/null 2>/dev/null\n" +
            "  if [ $? != \"0\" ]\n" +
            "  then\n" +
            "       # 調用一個用於發郵件的腳本\n" +
            "     python /usr/local/sbin/mail.py $email \"$ip down\" \"$ip is down\"\n" +
            "  fi\n" +
            "  sleep 30\n" +
            "done", "#!/bin/bash\n" +
            "ip=\"123.21.12.11\"\n" +
            "email=\"admin@example\"\n" +
            " \n" +
            "while 1\n" +
            "do\n" +
            "  ping -c10 $ip > /dev/null 2>/dev/null\n" +
            "  if [ $? != \"0\" ]\n" +
            "  then\n" +
            "       # 調用一個用於發郵件的腳本\n" +
            "     python /usr/local/sbin/mail.py $email \"$ip down\" \"$ip is down\"\n" +
            "  fi\n" +
            "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鍵，即可根據所選語言自動補全；

運行後，代碼版本差異對比效果如下所示；

滾動任一一側的縱向滾動條或橫向滾動條，另一側的也會跟着幅度動起來。