文章内容

2017/7/26 17:59:35,作 者: 黄兵

nodejs+express搭建javascript在线IDE Ⅱ

使用

下面,我使用阮一峰的《es6标准入门》的一个案例代码来演示如何使用本平台,其实这个平台的初衷就是学了配合阮老师的书来学习的。 阮老师的代码传送门:在此

var a = [1,2,3,4]; var set = neww Set(a); for(var item of a) { console.log(item); }

这个代码的演示程序,如下图所示

enter description here本系统的特点

系统采用nodejs+express进行开发的。但是主要的实现都是靠html+javascript来实现的,我当时是想用户传递自己输入的javascript语句到后台进行执行,但是根据常识,浏览器是可以直接运行javascript代码的,因此,就想到了eval这个让大家又爱又怕的函数来执行我们输入的javascript语句,并且捕获异常,将捕获的异常信息做为bootstrap-treeview插件的数据来显示具有层次结果的错误信息。(这里我可能描述的不够准备,捕获的是Error.

总结几个特点:

  1. 使用最新的的CodeMirrror,包含了所有的样式和addon。用户可以根据自己喜欢来设置自己喜欢的代码编辑区的配色方案。
  2. 利用CodeMirrorcursorActivity事件来完成代码提示的触发。网上一群坑爹的货,居然说用onChange事件,老子的浏览器选项卡直接卡死,在仔细看了官方的文档后,发现cursorActivity事件才是解决代码提示的正确道路。
  3. 利用split函数将用户输入的所有的代码按照空格进行分割,获取所有的英文单词,将这些单词传递给一个自定义的全局变量CodeMirror.ukeys,结合javascript的关键字来实现代码提示,所以,本系统能够实现实时的代码提示,而且可以提示用户出入的变量名,不仅仅是javascript关键词,从而给人更真实的IDE感
  4. 由于时间较多,没有做很多的后台的程序的编写, 大家有兴趣的,可以mysql或者mongodb来实现类似于HUE的在线IDE。

关于CodeMirror如何实现实时提示

这个问题在原生的CodeMirror有两个问题,

问题1

一个问题就是代码提示的时候,在没有任何输入的时候就会弹出所有的提示关键词,这一点让人很讨厌,那么该如何改进呢。由于我们这里使用的javascript-hint.js来进行javascript代码的提示,那我们可以修改的文件就应该是public/codemirror/addon/hint/javascript-hint.js文件,如果大家仔细的阅读了CodeMirror的代码,就会发现在javascript-hint.js文件中有一个函数getCompletions,该函数有一个参数叫token,这个token其实是编译原理中所说的token,也就是一个语法分割单位,这个token是我们代码提示的关键,所有的关键字就要跟token进行比对,如果发现token是某些关键字的前缀,那么这些单词都要作为当前的关键字提示给用户。 例如,下图中,我们正在输入的语法单词是se,那么此时触发的cursorActivity事件调用showHint方法,经过一系列的函数判断,最重获取到当前的tokense,则我们需要将所有以se为首的单词进行弹出提示。那么,针对我们正在说的这个事情:CodeMirror在我们没有任何输入的时候,也会进行代码提示,那根据分析没有任何输入时,触发cursorActivity事件时,得到的token的值是"",我们只需要在getCompletions函数(这个函数就是获取和当前用户正在输入的语法单词匹配的所有关键词的函数)的开始判断token=="",如果是true,则直接返回一个空的list{}。

enter description here 改写的代码如下:

function getCompletions(token, context, keywords,options) { //这里是处理没有任何字母输入时也会有代码提示的原因。 if (token.string == "") { return {list:{}};; } ... }

问题2

另外一个问题就是CodeMirror能提供的auto-complete(代码自动完成)是需要进行按键绑定的,用户通过某个按键组合才能触发autocomplete事件,这对于我们写代码的速度肯定影响是很大。因此,我们希望在我们输入字符的同时,界面可以给出我们实时的代码提示,而不需要进行按键组合来触发。一般网上的示例都是比较坑爹的,代码示例如下:

editor.on("change", function () { editor.showHint(); });

如果你是这么用CodeMirror的,或者你正在发愁的时候,我希望我的这的总结能够给你提供比较的帮助。继续说,上面的代码示例千万不要用,因为这样做了,浏览器会卡死的,而造成这种现象 的原因可能是CodeMirror内部处理的问题,我没有仔细研究,但是经过我的仔细阅读官方文档和不断摸索,我给出一个比较正确的方案来实现代码的实时提示。

//不要用change editor.on("cursorActivity", function () { //调用显示提示 editor.showHint(); });

如果,你是这么做的或者你刚好这么改正了,那么恭喜你,你应该得到了你要的效果。

好了,这两个问题,就简单论述到这里,下面还有更重要的东西需要我来论述的。

如何增加CodeMirror代码提示的关键字

enter description here

不失一般性,我这里就描述一下这个项目中,我是如何获取更多的关键字(这里的关键字是指匹配用户输入的提示单词)并且将这样单词进行匹配并跟随原有的关键字进行实时提示的。

还记得刚才看过的那个代码片段吧,上面的代码是我为了给大家描述如何来触发代码实时提示的解决方案的。下面才是本项目中实际用到的代码。下面的代码注释已经写的很清楚的,首先就是利用CodeMirrorAPI来获取用户输入代码(注意是纯代码),然后利用正则来提取出所有的单词,用match匹配后得到的是一个数组,然后将该数组传递给我们拓展在CodeMirror全局变量的上一个属性ukeys。然后再调用editor.showHint()来处理实际的代码提示。

 /**
 * 用来实时对用户的输入进行提示
 */
editor.on("cursorActivity", function () {
	//获取用户当前的编辑器中的编写的代码
	var words = editor.getValue() + "";
	//利用正则取出用户输入的所有的英文的字母
	words = words.replace(/[a-z]+[\-|\']+[a-z]+/ig, '').match(/([a-z]+)/ig);
	//将获取到的用户的单词传入CodeMirror,并在javascript-hint中做匹配
	CodeMirror.ukeys = words;
	//调用显示提示
	editor.showHint();
});

上面的描述希望没有给您带来阅读上的不顺畅,下面,我将描述一下如何在javascript-hint.js文件中如何接受我们传入的ukeys以及如何利用内置的函数快速完成关键字的匹配并将匹配的结果叠加进行关键字的提示。

首先是javascript-hint.js中javascript代码提示的主调函数

如果你对下面的文字描述不感兴趣,请移步github(点我),直接看源码(有注释).

    /**
     * 主调函数,加入了我自己定义的一个CodeMirror.ukeys变量,用来向CodeMirror传递用户
     * 输入的所有的单词
     * @param editor
     * @param options
     * @returns {{list, from, to}|*}
     */
    function javascriptHint(editor, options) {

        var ukeys =  CodeMirror.ukeys;//获取用户的所有的输入的单词
        return scriptHint(editor, javascriptKeywords,ukeys,
            function (e, cur) {
                return e.getTokenAt(cur);
            },
            options);
    };

如上面的代码所示,在javascriptHint函数中,我们获取到CodeMirror.ukeys,并将ukeys传递给scriptHint函数。scriptHint函数的主要代码如下:

    //这是处理关键字匹配的关键函数实现
    function scriptHint(editor, keywords, ukeys,getToken, options) {
        // Find the token at the cursor
        var cur = editor.getCursor(), token = getToken(editor, cur);
        if (/\b(?:string|comment)\b/.test(token.type)) return;
        token.state = CodeMirror.innerMode(editor.getMode(), token.state).state;

        // If it's not a 'word-style' token, ignore the token.
        if (!/^[\w$_]*$/.test(token.string)) {
            token = {
                start: cur.ch, end: cur.ch, string: "", state: token.state,
                type: token.string == "." ? "property" : null
            };
        } else if (token.end > cur.ch) {
            token.end = cur.ch;
            token.string = token.string.slice(0, cur.ch - token.start);
        }

        var tprop = token;
        // If it is a property, find out what it is a property of.
        while (tprop.type == "property") {
            tprop = getToken(editor, Pos(cur.line, tprop.start));
            if (tprop.string != ".") return;
            tprop = getToken(editor, Pos(cur.line, tprop.start));
            if (!context) var context = [];
            context.push(tprop);
        }
        return {
            list: getCompletions(token, context, keywords,ukeys, options),
            from: Pos(cur.line, token.start),
            to: Pos(cur.line, token.end)
        };
    }

从上面的代码中,可以看到scriptHint函数主要是获取list(匹配的关键字)。这也印证了上面我在处理没有任何输入时,判断token==""返回的是{list:{}}是正确的写法。这个函数的改动很小,主要还是将ukeys继续向下传递list: getCompletions(token, context, keywords,ukeys, options)。所以的单词匹配都是在getCompletions函数中实现的,在这个函数中,提供了很多内置函数,我们只需要添加几行代码就可以完成附加关键词的功能了。该函数的改动后的代码如下所示:

 /**
     *
     * @param token 当前光标下用户正在输入的单词
     * @param context
     * @param keywords 关键字列表,本文件内定义
     * @param ukeys 用户添加的关键字
     * @param options
     * @returns {*}
     */
    function getCompletions(token, context, keywords, ukeys,options) {

        //这里是处理没有任何字母输入时也会有代码提示的原因。
        if (token.string == "") {
            return {list:{}};
        }
        var found = [], start = token.string, global = options && options.globalScope || window;

        function maybeAdd(str) {
            if (str.lastIndexOf(start, 0) == 0 && !arrayContains(found, str)) found.push(str);
        }

        function gatherCompletions(obj) {
            if (typeof obj == "string") forEach(stringProps, maybeAdd);
            else if (obj instanceof Array) forEach(arrayProps, maybeAdd);
            else if (obj instanceof Function) forEach(funcProps, maybeAdd);
            forEach(ukeys,maybeAdd);//匹配我们传进来的用户输入的代码中的所有的单词
            forAllProps(obj, maybeAdd)
        }

        if (context && context.length) {
            // If this is a property, see if it belongs to some object we can
            // find in the current environment.
            var obj = context.pop(), base;
            if (obj.type && obj.type.indexOf("variable") === 0) {
                if (options && options.additionalContext)
                    base = options.additionalContext[obj.string];
                if (!options || options.useGlobalScope !== false)
                    base = base || global[obj.string];
            } else if (obj.type == "string") {
                base = "";
            } else if (obj.type == "atom") {
                base = 1;
            } else if (obj.type == "function") {
                if (global.jQuery != null && (obj.string == '$' || obj.string == 'jQuery') &&
                    (typeof global.jQuery == 'function'))
                    base = global.jQuery();
                else if (global._ != null && (obj.string == '_') && (typeof global._ == 'function'))
                    base = global._();
            }
            while (base != null && context.length)
                base = base[context.pop().string];
            if (base != null) gatherCompletions(base);
        } else {
            // If not, just look in the global object and any local scope
            // (reading into JS mode internals to get at the local and global variables)
            for (var v = token.state.localVars; v; v = v.next) maybeAdd(v.name);
            for (var v = token.state.globalVars; v; v = v.next) maybeAdd(v.name);
            if (!options || options.useGlobalScope !== false)
                gatherCompletions(global);
            forEach(keywords, maybeAdd);
        }
        //console.log(found);
        return found;
}

我们只在gatherCompletions函数中添加了一条语句 好了,如果你这么做了,就可以完成我们输入的变量也会出现在CodeMirror中了。

附赠的福利

CodeMirror还提供了sql的代码提示的附加功能。主要针对的有MSSQLmysqlmariadb以及PLSQL。本文以一个实际的项目中的实际使用来演示如何按照上文的描述来修改对应的sql-hint.js中的内容来完成:

  1. 取消没有输入任何有效字符时的代码提示问题
  2. cursorActivity设置代码实时提示
  3. 增加表的字段到代码提示中去。

问题1

sql对应的关键字信息在CodeMirror/mode/sql/sql.js中,我在项目中用的是类似于oracle的数据库,因此我们在sql.js增加了PLSQL的部分关键字,如下图所示(更详细的信息,请参考我的github

enter description here

然后修改CodeMirror/addon/hint/sql-hint.js中的CodeMirror.registerHelper("hint", "sql", function (editor, options) {函数中添加如下图所示的代码,同样是判断token是否==""enter description here

问题2及问题3

由于问题2和问题三都是在cursorActivity中编写。直接上代码来描述吧。 获取所有的表字段 我的项目中,在编写sql的页面有所有的字段信息,所以我就用jquery直接获取了,如果大家的字段不在页面中,那就用ajax请求在页面一次加载的时候就保存在页面的一个全局变量中吧。一定不要让浏览器都去发ajax请求去获取字段列表,那样不卡死才怪。

$(function(){ console.log("get field"); $(".field .easytree-title").each(function (){ var tmp =$(this).html(); tmp = tmp.substring(0,tmp.indexOf("[")); window.fields.push(tmp); }) });

上面的代码获取了我的项目中的所有的字段,并作为一个数组存储在全局变量window.fields上。然后再在cursorActivity中传递到sql-hint.js中。 字段传递及关键字的匹配

editor.on("cursorActivity",function(){ CodeMirror.ukeys = window.fields; editor.showHint(); });

sql-hint.js文件的改写2 在CodeMirror.registerHelper("hint", "sql", function (editor, options) {中添加如下图所示的代码,就完成了单词的匹配及后续的匹配到的单词的显示。

enter description here

上图的代码也就是利用封装好的函数读取CodeMirror.ukeys并进行关键字匹配,如果匹配成功则加入到result中,最后返回的list就是result.

最后上一个效果图。所有改动后的文件都在本次示例的项目中。github地址(点我)

enter description here

本文转载自:github - js-online-running

分享到:

发表评论

评论列表