Asp.Net Core 使用Monaco Editor 實現程式碼編輯器

尋找無名的特質發表於2022-01-05
ASP.NET

在專案中經常有程式碼線上編輯的需求，比如修改基於Xml的配置檔案，編輯Json格式的測試資料等。我們可以使用微軟開源的線上程式碼編輯器Monaco Editor實現這些功能。Monaco Editor是著名的VSCode的前身，專案地址：https://microsoft.github.io/monaco-editor/。本文介紹在Asp.Net Core專案中使用Monaco Editor實現程式碼編輯器功能。

安裝

可以使用npm下載moaco-editor:

npm install monaco-editor@0.31.1

我們需要的檔案在node_modules/monaco-editor/min/vs目錄中，將整個vs目錄拷貝到Asp.Net Core Web專案的wwwroot/lib目錄下：

在Program.cs中需要啟動靜態檔案:

app.UseStaticFiles();

在佈局頁面中引入如下css和js:

    <link data-name="vs/editor/editor.main" rel="stylesheet" href="~/lib/vs/editor/editor.main.css" />

    <script  src="~/lib/vs/loader.js"></script>
    <script  src="~/lib/vs/editor/editor.main.nls.js"></script>
    <script src="~/lib/vs/editor/editor.main.js"></script>

基本的環境設定就完成了。

基本功能

現在可以在頁面中實現編輯器的基本功能，在頁面中增加一個div，作為編輯器容器:

<div id="container" style="width:800px;height:600px;border:1px solid grey"></div>

然後增加編輯器的js程式碼：

<script>
    $(document).ready(function () {
        require.config({ paths: { 'vs': '/lib/vs' } });
        monaco.editor.create(document.getElementById('container'), {
            value: "function sayHello(){\n console.write('Hello World');\n}",
            language: 'javascript'
        });
    })
</script>

設定

編輯器有多種設定，比如是否顯示程式碼行、顯示樣式等等，設定完成後，可以使用updateOptions修改設定，示例程式碼如下：

        var editor = monaco.editor.create(document.getElementById('container'), {
            value: "function sayHello(){\n console.write('Hello World');\n}",
            language: 'javascript',
            lineNumbers: 'on',
            roundedSelection: false,
            scrollBeyondLastLine: false,
            readOnly: false,
            theme: 'vs-dark'
        });

程式碼比較

monaco editor的一個強大的功能是文字比較功能，可以將兩段文字進行比較：

<script>
    require.config({ paths: { 'vs': '/lib/vs' } });
    var originalModel = monaco.editor.createModel(
        '刪除行\n行一\n行二\n行三內容\n更多內容',
        'text/plain'
    );
    var modifiedModel = monaco.editor.createModel(
        '\n行一\n行二\n行三\n更多內容\n增加行',
        'text/plain'
    );

    var diffEditor = monaco.editor.createDiffEditor(document.getElementById('container'), {
        // You can optionally disable the resizing
        enableSplitViewResizing: false
    });
    diffEditor.setModel({
        original: originalModel,
        modified: modifiedModel
    });

</script>

效果如下：

自定義語言

monaco editor 支援常見的幾乎所有程式語言，在編輯這些語言的程式碼時可以高亮顯示關鍵字，同時也支援對自定義語言的擴充套件。其功能非常強大，同時配置起來也比較複雜，這裡只舉個簡單的例子，說明如何使用。

這裡使用的“語言”很簡單，目的是記錄中國象棋的棋譜，關鍵字只有代表“車馬炮”等棋子的大寫漢語拼音，運算子只有代表向前、向後和平行移動的“++”、“--”和“==”，還有就是註釋。
使用自定義語言，首先要註冊這個語言的id:

        monaco.languages.register({ id: 'mylang' });

然後設定語言的Token Provider：

        monaco.languages.setMonarchTokensProvider('mylang', getlang());

這樣就可以在編輯器中使用這種自定義語言了，下面是完整的程式碼：

@page
@model CustomLanguageModel
@{
    ViewData["Title"] = "自定義語言";
}
<h1>@ViewData["Title"]</h1>


<div id="container" style="height: 800px"></div>
<script>
    var require = { paths: { vs: '/lib/vs' } };
</script>
@section Scripts
{
<script>
    $(document).ready(function () {
        
        monaco.languages.register({ id: 'mylang' });
        monaco.languages.setMonarchTokensProvider('mylang', getlang());

        var sampleEditor=monaco.editor.create(document.getElementById('container'), {
            model:null
        }
        );
        setTimeout(function(){
             var model=monaco.editor.createModel('// 炮二平五 \nPAO 2 == 5 \n//馬八進七 \nMA 8 ++ 7', 'mylang');
             sampleEditor.setModel(model);
        },1);
    });

    function getlang(){
        return {
            //車馬炮相士將帥兵卒
          keywords: [ 'JU', 'MA', 'PAO', 'XIANG', 'SHI', 'JIANG', 'SHUAI', 'BING', 'ZU' ],
          //++ 進 --退 ==平 
          operators: [ '++', '--', '=='  ],
          symbols:  /[=><!~?:&|+\-*\/\^%]+/,
          // The main tokenizer for our languages
          tokenizer: {
            root: [
              [/[A-Z][\w\$]*/, {cases: { '@@keywords': 'keyword' }}],  
              { include: '@@whitespace' },
              [/@@symbols/, { cases: { '@@operators': 'operator'} } ],
              [/\d./, 'number'],
            ],
            comment: [
              [/[^\/*]+/, 'comment' ],
              [/\/\*/,    'comment', '@@push' ],   
              ["\\*/",    'comment', '@@pop'  ],
              [/[\/*]/,   'comment' ]
            ],
            whitespace: [
              [/[ \t\r\n]+/, 'white'],
              [/\/\*/,       'comment', '@@comment' ],
              [/\/\/.*$/,    'comment'],
            ],
          },
        };
    }
</script>
}}

效果如下：

本文的示例專案已經上傳到github: https://github.com/zhenl/monacoEditorDotNet

相關文章