如何开发HTML编辑器

在线的HTML内容编辑器为用户提供文本的样式控制,例如文字的颜色、字体大小等。虽然现在网上有不少功能强大的编辑器(如:FCKEditor),但是在使用中需要许多复杂的配置,而且代码往往比较“臃肿”。本文的目的就是介绍如何开发一个HTML编辑器。应用本文介绍的方法,可以方便的开发出满足自己需求的,代码相对比较精简的HTML编辑器。以下是一个应用本文方法开发的HTML编辑器,实现了一些简单的功能:

代码下载

开发方法如下:

1.添加一个可编辑的iframe

实现HTML编辑器的第1步就是在网页中放置一个可编辑的iframe用来输入文本,使iframe可编辑方法相当简单,只需要将iframe的designMode设置为on即可,具体步骤如下:

var editor = document.getElementById("IFRAME的ID");

var editorDoc = editor.contentWindow.document;
var editorWindow = editor.contentWindow;

editorDoc.designMode = "on";

editorDoc.open();
editorDoc.write("<html><head></head><body style='margin:0px; padding: 0px;'></body></html>");
editorDoc.close();

2.设置选中文本的样式

设置选中文本样式的方法最简单的方式就是使用document.execCommand,但是execCommand功能比较局限,有时不能满足需求,例如:execCommand设置字体大小只能是1-7,不能使用像素大小,而且如果你在点击工具栏按钮到调用execCommand的过程中点击了其他的DIV,iframe的选中内容会消失,这时调用execCommand是无效的。因此本文介绍另一种方法,基本思路如下:

(1) 获取选中的HTML;
(2) 修改HTML的样式;
(3) 用修改后的HTML替换选中的HTML。

2.1 获取选中的HTML

在不同的浏览器中获取选中的HTML的方法是不同的,在IE中可以使用

var range = document.selection.createRange()
在Firefox,Chrome中则使用
var range = window.getSelection().getRangeAt(0);

2.2 替换选中的HTML

通过2.1的方法获取了表示选中内容的对象后,就可以调用其方法来替换掉选中的内容。在不同的浏览器中替换选中的HTML的方法有所差异,在IE中可以只需调用range.pasteHTML就行了,在Firefox,Chrome中则使用range.deleteContents 和 range.insertNode 两个方法来实现

2.3 封装一个操作选中HTML的类

由于2.1中获取的range对象的方法在不同浏览器中差异很大,因此,为了方便实现2.1和2.2提到的两个操作,封装了一个操作选中HTML的类SelectionRange,该类有两个方法,GetSelectedHtml和Replace,分别用于获取HTML和替换HTML。其代码如下:


//用于记录浏览器的类型
var browser = {};

var ua = navigator.userAgent.toLowerCase();

browser.msie = (/msie ([\d.]+)/).test(ua);
browser.firefox = (/firefox\/([\d.]+)/).test(ua);
browser.chrome = (/chrome\/([\d.]+)/).test(ua);

//获取多个节点的HTML
function GetInnerHTML(nodes)
{
    var builder = [];
    for (var i = 0; i < nodes.length; i++)
    {
        if (nodes[i].nodeValue != undefined)
        {
            builder.push(nodes[i].innerHTML);
        }
        else
        {
            if (nodes[i].textContent) builder.push(nodes[i].textContent.replace(/\</ig, function() { return "<"; }));
            else if (nodes[i].nodeValue) builder.push(nodes[i].nodeValue.replace(/\</ig, function() { return "<"; }));
        }
    }
    return builder.join("");
}

function SelectionRange(doc, range)
{
    //获取选中的内容的HTML
    this.GetSelectedHtml = function()
    {
        if (range == null) return "";

        if (browser.msie)
        {
            if (range.htmlText != undefined) return range.htmlText;
            else return "";
        }
        else if (browser.firefox || browser.chrome)
        {
            return GetInnerHTML(range.cloneContents().childNodes);
        }
        else
        {
            return "";
        }
    }

    //用html替换选中的内容的HTML
    this.Replace = function(html)
    {
        if (range != null)
        {
            if (browser.msie)
            {
                if (range.pasteHTML != undefined)
                {
                    //当前选中html可能以为某种原因(例如点击了另一个DIV)而丢失,重新选中
                    range.select();
                    range.pasteHTML(html);
                    return true;
                }
            }
            else if (browser.firefox || browser.chrome)
            {
                if (range.deleteContents != undefined && range.insertNode != undefined)
                {
                    //将文本html转换成DOM对象
                    var temp = doc.createElement("DIV");
                    temp.innerHTML = html;

                    var elems = [];
                    for (var i = 0; i < temp.childNodes.length; i++)
                    {
                        elems.push(temp.childNodes[i]);
                    }
                    
                    //删除选中的节点
                    range.deleteContents();
                    
                    //将html对应的节点(即temp的所有子节点)逐个插入到range中,并从temp中删除
                    for (var i in elems)
                    {
                        temp.removeChild(elems[i]);
                        range.insertNode(elems[i]);
                    }
                    return true;
                }
            }
        }
        return false;
    }
}

与此同时,还实现了一个函数GetSelectionRange用于获取当前选中文本对应的SelectionRange对象,

function GetSelectionRange(win)
{
    var range = null;

    if (browser.msie)
    {
        range = win.document.selection.createRange();
        if (range.parentElement().document != win.document)
        {
            range = null;
        }
    }
    else if (browser.firefox || browser.chrome)
    {
        var sel = win.getSelection();
        if (sel.rangeCount > 0) range = sel.getRangeAt(0); else range = null;
    }

    return new SelectionRange(win.document, range);
}

2.4 修改选中的HTML的样式

修改选中的HTML的样式方法并不复杂,只需要将HTML转成DOM对象,然后递归的设置每一个节点对应的样式的值即可,具体代码如下:

function SetNodeStyle(doc, node, name, value)
{
    if (node.innerHTML == undefined)
    {
        return node;
    }
    else
    {
        node.style[name] = value;

        for (var i = 0; i < node.childNodes.length; i++)
        {
            var cn = node.childNodes[i];
            if (node.innerHTML != undefined)
            {
                SetNodeStyle(doc, cn, name, value);
            }
        }

        return node;
    }
}

function SetStyle(doc, html, name, value)
{
    var dom = doc.createElement("DIV");
    dom.innerHTML = html;

    for (var i = 0; i < dom.childNodes.length; i++)
    {
        var node = dom.childNodes[i];

        if (node.innerHTML == undefined)
        {
            //如果是文本节点,则转换转换成span
            var span = doc.createElement("SPAN");
            span.style[name] = value;
            if (node.nodeValue != undefined) span.innerHTML = node.nodeValue.replace(/\</ig, function() { return "<"; });
            else if (node.textContent != undefined) span.innetHTML = node.textContent.replace(/\</ig, function() { return "<"; });
            //替换掉文本节点
            dom.replaceChild(span, node);
        }
        else
        {
            SetNodeStyle(doc, node, name, value);
        }
    }

    return dom.innerHTML;
}

2.5 示例

使用以上的代码,就可以相当方便的实现一个HTML编辑器,例如,以下代码实现将选中文本的字体大小设置为32px:

var range = GetSelectionRange(editorWindow);
var html = SetStyle(editorDoc, range.GetSelectedHtml(), "fontSize", "32px");
range.Replace(html);

同理,你可以实现设置行距,缩进,插入图片等功能。

3.总结

本文给出的代码兼容IE,Firefox和Chrome,如果有其它问题可以通过EMail或者WebIM与我联系。

作者:卢春城
E-mail:mrlucc@126.com
出处:http://lucc.cnblogs.com/
本文版权归作者和博客园共有,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接。
posted @ 2010-03-22 23:33 卢春城 阅读(5307) 评论(22) 编辑 收藏

 回复 引用 查看   
#1楼 2010-03-23 09:10 贺爱平      
ding
 回复 引用 查看   
#2楼 2010-03-23 09:32 戏水      
希望你好好把这个系列写下去 。 浏览器兼容性可不那么好搞啊
 回复 引用 查看   
#3楼 2010-03-23 09:48 annpaul      
不错!看了您这篇帖子真是如梦初醒,以前的一些困惑都清晰了,多谢分享!
 回复 引用 查看   
#4楼[楼主] 2010-03-23 09:59 卢春城      
@戏水
文中给出的函数已经兼容IE,firefox和chorme

 回复 引用 查看   
#5楼 2010-03-23 10:43 草鱼真      
Good job, 一直想要了解这个原理。
 回复 引用 查看   
#6楼 2010-03-23 13:22 JkD      
顶..........
 回复 引用 查看   
#7楼 2010-03-23 14:27 SuperSaiyan      
我觉得, 对于html编辑器, 最主要的问题已经不是实现功能的问题, 而是安全性的问题.
 回复 引用 查看   
#8楼 2010-03-23 14:29 SuperSaiyan      
目前有各种处理方法, 什么白单了黑单了等等. 但是, 缺乏比较能够获得大家一致认可的开源的解决方案
 回复 引用 查看   
#9楼 2010-03-23 14:33 SuperSaiyan      
在google搜索中, 好多国内的网站, 被列为含有恶意代码, 估计都是因为过于随意的使用编辑期, 而不在安全上进行适当的过滤所导致
 回复 引用 查看   
#10楼[楼主] 2010-03-23 14:42 卢春城      
@SuperSaiyan
本文的目的是介绍如何开发HTML编辑器,如果HTML编辑器是自己开发的,是不是安全性会更好一点呢?

 回复 引用 查看   
#11楼 2010-03-23 16:42 徐佳佳      
哥,有脚本错误
先选中事先加的图后,再点加图就报错了

 回复 引用 查看   
#12楼 2010-03-23 16:43 徐佳佳      
不是选中,是点一下,会出现小框框的那个
 回复 引用 查看   
#13楼[楼主] 2010-03-23 17:22 卢春城      
@徐佳佳
IE确实有这个问题,因为这种情况下返回的range对象不一样

 回复 引用 查看   
#14楼 2010-03-23 22:14 Tony Qu      
建议写写如何处理paste内容,比如从office里面贴过来的内容
 回复 引用 查看   
#15楼 2010-03-23 23:41 SuperSaiyan      
@卢春城
不起作用. 这种过滤应当是在server端进行的, 和client端关系不大. 因为恶意代码, 在hacker自己的机器上, 不管如何, 都不关网站的事, 只有当它被加到server上后, 并被其他用户打开时, 才能发挥hacker所希望的作用.
当然了, 你也可以在client端就进行过滤, 但是, 这种过滤是不可信的, 即使过滤了, 到server端后, 还要再进行检查.

 回复 引用 查看   
#16楼 2010-03-24 17:02 hailibu      
请问:
1、如何获取编辑器中的内容
2、如何给编辑器赋值

 回复 引用 查看   
#17楼[楼主] 2010-03-24 18:23 卢春城      
@hailibu
var editor = document.getElementById("IFRAME的ID");
var editorDoc = editor.contentWindow.document;

var content = editorDoc.body.innerHTML;

editorDoc.body.innerHTML = "content";

 回复 引用 查看   
#18楼 2010-04-26 02:27 zeyoo      
你的文章真的要好好读一读
 回复 引用 查看   
#19楼 2010-04-26 02:28 zeyoo      
仅仅用JS就实现了,真的很尺讶
 回复 引用 查看   
#20楼[楼主] 2010-04-26 10:05 卢春城      
@zeyoo
谢谢支持

 回复 引用 查看   
#21楼 2010-09-16 14:55 维子      
麻烦问下,按回车的时候怎样替换成br呢?
 回复 引用 查看   
#22楼 2011-03-13 20:02 skyaspnet      
感谢楼主的分享,请教楼主一个困扰已久的问题:

编辑器上有一个插入<h2>标题</h2>的功能,现在插入功能是可以了,

但是当我鼠标在这个标签里时,编辑器的按钮并不显示选中状态,也就是

说并不像加粗功能按钮一样,加粗的按钮当鼠标在<b>加粗内容</b>区域

时有选中的状态,并且点击会取消加粗效果,请问这样是如何实现的呢?

非常感谢!