在JSP里使用CKEditor和CKFinder

时间 2019-11-10

原文原文链接

最近在作一个新闻发布平台，放弃了很早的FCKEditor，使用CKEditor和CKFinder，尽管免费的CKFinder是Demo版本，可是功能完整，并且用户都是比较集中精神发新闻的人，不会在乎这个。按照官网的document一步一步配置，虽然并不难，可是有些东西特别分散，仍是全英文的，因此我就整理了一下安装过程和配置，以及须要注意的一些问题。但愿对你们有所帮助。

目录javascript

1. 下载CKEditor相关的安装文件php

2. 安装CKEditor和CKFinderhtml

3. 在网页里使用CKEditorjava

4. CKEditor的三种配置方式web

5. CKEditor的一些配置选项api

6. 关于CKEditor编辑器里面回车的问题浏览器

7. 将CKFinder整合进CKEditor安全

8. 配置CKFinder服务器

9. 在项目里配置CKFinder的servletapp

10. 更安全的使用CKFinder

1. 下载CKEditor相关的安装文件

CKEditor: 在 http://ckeditor.com/download 页面左侧，能够下载到各类版本的CKEditor，包括完整版full、标准版standard、基础版basic等。在页面右侧上方，还有可定制的下载，能够选择Toolbar类型、插件、语言等。这里咱们选择4.1版本的Full版本，下载后获得CKEditor_4.1_full.zip 。
CKEditor for java: 在http://ckeditor.com/download 页面右侧下部，能够下载到用于服务器端的工具，记得选择for java版本。这里选择3.6.4版本。可是下载下来倒是 ckeditor-java-core-3.5.3.jar。不知道为何。
CKFinder: 在 http://cksource.com/ckfinder/trial 页面，能够下载到各类版本的CKFinder。仍然选择java版。这里咱们下载的是2.3.1版本，下载后获得CKFinder_java_2.3.1.zip。

2. 安装CKEditor和CKFinder

解压CKEditor_4.1_full.zip，把解压获得的目录 ckeditor 彻底复制到网站根目录下，也就是和WEB-INF同级。能够给这个目录加上版本号，即ckeditor4.1。
把 ckeditor4.1/samples 彻底删掉，把 ckeditor4.1/lang 里面除了en.js和zh-cn.js以外的文件删掉，把 ckeditor4.1 下的README.md, CHANGES.md删掉。
把 ckeditor-java-core-3.5.3.jar 放到yourapp/WEB-INF/lib下
解压CKFinder_java_2.3.1.zip，获得ckfinder目录。将 ckfinder/CKFinderJava/ckfinder 目录彻底复制到网站根目录下，也就是和WEB-INF同级。能够给这个目录加上版本号，即ckfinder2.3.1。
把 ckfinder2.3.1/_samples彻底删掉，把 ckfinder2.3.1/lang 下除了en.js和zh-cn.js以外的文件删掉，把 ckfinder2.3.1 下的changelog.txt，install.txt，license.txt，translations.txt删掉。
把 ckfinder/CKFinderJava/WEB-INF/lib 下全部的jar包复制到yourapp/WEB-INF/lib下。
把 ckfinder/CKFinderJava/WEB-INF/config.xml复制到yourapp/WEB-INF下，并更名为ckfinder.xml。

3. 在网页里使用CKEditor

Step1：找到须要放置CKEditor编辑器的页面，引入CKEditor的js文件（${contextPath}是JSTL写法，请改为你本身的路径写法，绝对路径或者相对路径）

<script type="text/javascript" src="${contextPath}/ckeditor4.1/ckeditor.js"></script>

Step2：在须要提交的form里，写一个<textarea>

<form id="detailForm" method="post"> <textarea id="content" name="content"></textarea> <input type="button" value="保存" id="save" onclick="save()" /> </form>

Step3：建立CKEditor实例

<script type="text/javascript"> var editor = null; window.onload = function(){ editor = CKEDITOR.replace('content'); //参数‘content’是textarea元素的name属性值，而非id属性值 } </script>

注意上面代码中editor=CKEDITOR.repalce()必须写在window.onload事件里，或者写在textarea元素后面，以避免出现content不存在的错误。上述代码并非建立CKEditor实例的惟一方法，你们能够自行查阅资料。

Step4：在页面js中为CKEditor编辑器设置/获取值

editor.setData('这里是须要传递给CKEditor编辑器实例的值');
editor.getData();

注意，上面代码中用到了一个变量editor，就是Step3中定义的那个editor。这也就是为何Step3里面要单独写var editor = null这句代码。固然，在<textarea></textarea>中直接设置值也能够，可是那只能在 CKEDITOR.replace()以前起做用。

Step5：在后台java代码中获取CKEditor编辑器的值

<script type="text/javascript"> function save(){ editor.updateElement(); //很是重要的一句代码 //前台验证工做 //提交到后台  } </script>

由于CKEditor编辑器取代了原来咱们写的textarea元素，因此咱们在编辑器里写的内容，其实都不在textarea中，所以，为了能在后台通过textarea得到值，必须用editor.updateElement()来更新textarea元素。这样，在后台java代码中就能够用 request.getParameter('content');或者其余代码获得编辑器的内容了，不然获得的极可能不是编辑器里的内容。

4. CKEditor的三种配置方式

方式一：修改ckeditor4.1/config.js文件

CKEDITOR.editorConfig = function( config ) { config.language = 'zh-cn'; config.uiColor = '#AADC6E'; };

方式二：复制ckeditor4.1/config.js，仍然放在ckeditor4.1目录下，可是更名为myconfig.js，并在这个文件中修改配置。可是要在建立编辑器实例时指明配置文件路径：

<script type="text/javascript">
    var editor = null; window.onload = function() { editor = CKEDITOR.replace( 'content', { customConfig:'${contextPath}/ckeditor4.1/myconfig.js' }); };
</script>

方式三：在建立编辑器实例时指定配置

<script type="text/javascript">
    var editor = null; window.onload = function() { editor = CKEDITOR.replace( 'content',  uiColor: '#9AB8F3', language:'zh-cn' }); }; </script>

使用第二种或者第三种方式的好处就在于，当你更新CKEditor版本时，不至于由于直接复制了新的config.js而覆盖掉个性配置。

5. CKEditor的一些配置选项

完整的CKEditor的配置选项在这里。下面是一些经常使用的配置。

language，defaultLanguage，contentLanguage, uiColor
autoGrow_maxHeight, autoGrow_minHeight, resize_maxHeight, resize_minHeight, resize_maxWidth, resize_minWidth
toolbarCanCollapse, toolbarGroups
forcePasteAsPlainText, pasteFromWordKeepsStructure, pasteFromWordRemoveFontStyles, pasteFromWordRemoveStyles
font_names, fontSize_sizes

6. 关于CKEditor编辑器里面回车的问题

在CKEditor编辑器里面敲回车，默认是加一个<p></p>元素，并且在<p>以前和</p>以后会加换行。这就形成一个问题，保存的数据最后可能会出现“\t\n”。当咱们使用editor.setData(......)时，实际上变成了

editor.setData(......
);

由于数据自己带有一个\t\n，使得js代码换行了，从而页面出错。可能还有其余方法解决这个问题，可是我采用的是禁止在回车变<p></p>时在后面添加换行。其方法是：

<script type="text/javascript">
    var editor = null; window.onload = function() { editor = CKEDITOR.replace( 'content', { customConfig:'${contextPath}/ckeditor4.1/myconfig.js', on: { instanceReady: function( ev ) { this.dataProcessor.writer.setRules( 'p', { indent: false, breakBeforeOpen: false, //<p>以前不加换行 breakAfterOpen: false, //<p>以后不加换行 breakBeforeClose: false, //</p>以前不加换行 breakAfterClose: false //</p>以后不加换行7 }); } } }); }; </script>

关于这部份内容，更多内容参看 http://docs.ckeditor.com/#!/guide/dev_output_format

7. 将CKFinder整合进CKEditor

没有CKFinder，CKEditor做为一个编辑器，也是能够正常使用的，可是没法在编辑器里浏览服务器上的用户上传文件。因此要整合CKFinder。

Step1：在页面中引入CKFinder的js文件

<script type="text/javascript" src="${contextPath}/ckfinder2.3.1/ckfinder.js"></script>

Step2：建立CKFinder实例

<script type="text/javascript">
    var editor = null; window.onload = function() { editor = CKEDITOR.replace( 'content', { customConfig:'${contextPath}/ckeditor4.1/jwc_config.js' }); CKFinder.setupCKEditor( editor, '${contextPath}/ckfinder2.3.1/' ); }; </script>

上面标红的代码，第一个参数是CKEditor实例，第二个参数是ckfinder的目录(最好写绝对路径)，注意最后要带斜杠'/'。

Step3：在CKEditor里配置经过哪一个页面或者程序来浏览和上传文件

找到你的项目里配置CKEditor的位置(参看本文CKEditor的三种配置方式部分)，配置如下内容：

CKEDITOR.editorConfig = function( config ) {
 //其余一些配置 filebrowserBrowseUrl = '/ckfinder2.3.1/ckfinder.html'; filebrowserImageBrowseUrl = '/ckfinder2.3.1/ckfinder.html?type=Images'; filebrowserFlashBrowseUrl = '/ckfinder2.3.1/ckfinder.html?type=Flash'; filebrowserUploadUrl = '/ckfinder2.3.1/core/connector/java/connector.java?command=QuickUpload&type=Files'; filebrowserImageUploadUrl = '/ckfinder2.3.1/core/connector/java/connector.java?command=QuickUpload&type=Images'; filebrowserFlashUploadUrl = '/ckfinder2.3.1/core/connector/java/connector.java?command=QuickUpload&type=Flash'; };

上面的六行代码，指定了经过ckfinder2.3.1/ckfinder.html来浏览图片或者其余文件，经过/ckfinder2.3.1/core/connector/java/connector.java来上传文件。

8. 配置CKFinder

找到yourapp/WEB-INF/ckfinder.xml，编辑其中的内容。下面简要介绍一下每一项的含义，其余未介绍的内容请参照ckfinder.xml自己的注释以及这里。

enabled：true表示开启ckfinder功能。默认是false。
baseDir：上传文件存放的路径，这里必须写从物理地址的全路径，好比C:\myapp\uploadfiles\。不能写相对路径，并且最后必定要加斜杠“/”。这一项能够不配置，留空的话，系统会自动根据baseURL去找到baseDir。可是建议仍是配置上比较好。
baseURL：上传文件存放的URL，这里能够写一个相对路径或者一个完整的URL，好比"http://www.example.com/uploadfiles/" 或者 "/uploadfiles/"。注意，必定要在最后加一个斜杠“/”。更多解释参看这里。
types：指定上传文件的类型。它的子元素是<type name=""></type>，其中的name要和上面CKEditor里配置的路径的type一致。好比上面配置了filebrowserImageBrowseUrl = 'ckfinder2.3.1/ckfinder.html?type=Images'，那么就要配一个<type name="Images"></type>。在<type></type>元素里，能够配置该类型文件存放的子目录(放在baseDir下)、子URL、文件最大字节数、容许上传的文件扩展名、禁止上传的文件扩展名。
disallowUnsafeCharacters：设置为false。若是设置为true，在建立文件夹或者上传文件时，名字里不能包含不安全的字符。这只在IIS里生效。
checkDoubleExtension：检查多级扩展名，或许你禁止用户上传php文件，容许用户上传rar文件。若是此项设置为false，文件foo.php.rar就会上传到服务器，这不安全。所以此项设置为true。
secureImageUploads：设置此项为true，能够检查文件究竟是不是图片，颇有可能有人把一个可执行文件加了后缀变成了.jpg，但实际上它不是一个图片文件。

9. 在项目里配置CKFinder的servlet

找到yourapp/WEB-INF/web.xml，添加如下内容：

<servlet> <servlet-name>ConnectorServlet</servlet-name> <servlet-class>com.ckfinder.connector.ConnectorServlet</servlet-class> <init-param> <param-name>XMLConfig</param-name> <param-value>/WEB-INF/ckfinder.xml</param-value> </init-param> <init-param> <param-name>debug</param-name> <param-value>false</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>ConnectorServlet</servlet-name> <url-pattern> /ckfinder2.3.1/core/connector/java/connector.java </url-pattern> </servlet-mapping>

上面配置里第一个init-param是指定CKFinder的配置文件位置。也就是上面第8部分提到的那个配置文件。

10. 更安全地使用CKFinder

目前来讲，CKFinder可以正常地使用了。可是，即使没有你的项目的管理权限，在浏览器中输入yoursite/ckfinder2.3.1/ckfinder.html，也同样能看到你的服务器上存放的那些文件，他们甚至能够上传和删除文件。有两个地方能够增强CKFinder的安全性。

在yourapp/WEB-INF/ckfinder.xml里配置访问权限

<userRoleSessionVar>CKFinder_UserRole</userRoleSessionVar> <accessControls> <accessControl> <role>admin</role> <resourceType>*</resourceType> <folder>/</folder> <folderView>true</folderView> <folderCreate>true</folderCreate> <folderRename>true</folderRename> <folderDelete>false</folderDelete> <fileView>true</fileView> <fileUpload>true</fileUpload> <fileRename>true</fileRename> <fileDelete>false</fileDelete> </accessControl> </accessControls>

而后在java代码中合适的位置，好比login()方法里，添加如下代码

request.getSession().setAttribute("CKFinder_UserRole", "admin");

系统会在访问yoursite/ckfinder2.3.1/ckfinder.html时（包括点击下图的“浏览服务器”按钮），检查CKFinder_UserRole的值是什么，它具备的权限是什么。若是一我的没有登陆系统，而是直接访问yoursite/ckfinder2.3.1/ckfinder.html，那么系统就会检查到CKFinder_UserRole是null，他就看不到服务器上的文件。

自写代码检查用户是否有权限使用CKFinder

在yourapp/WEB-INF/web.xml里，修改关于ckfinder的配置，增长一段代码：

<servlet> <servlet-name>ConnectorServlet</servlet-name> <servlet-class>com.ckfinder.connector.ConnectorServlet</servlet-class> <init-param> <param-name>configuration</param-name> <param-value>mypackage.CKFinderConfiguration</param-value> </init-param> <init-param> <param-name>XMLConfig</param-name> <param-value>/WEB-INF/ckfinder.xml</param-value> </init-param> <init-param> <param-name>debug</param-name> <param-value>false</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>ConnectorServlet</servlet-name> <url-pattern> /ckfinder2.3.1/core/connector/java/connector.java </url-pattern> </servlet-mapping>

在包路径mypackage下建立一个类CKFinderConfiguration(包路径和类名按照本身的项目代码组织状况来取名)，代码以下：

import com.ckfinder.connector.configuration.Configuration;
public class CKFinderConfiguration extends Configuration { public CKFinderConfiguration(ServletConfig servletConfig) { super(servletConfig); } @Override protected Configuration createConfigurationInstance() { return new CKFinderConfiguration(this.servletConf); } @Override public boolean checkAuthentication(final HttpServletRequest request){ String userid = request.getSession().getAttribute("userid"); boolean logined = !userid.equals(""); return logined; } }

关键在于checkAuthentication()方法。能够在checkAuthentication()方法里编写关于用户认证的一些判断，好比用户是否登陆系统，用户是否有权限管理上传文件。若是符合条件，就返回ture，不然返回false。

两种方法均可以让ckfinder更安全，固然同时使用会更好。可是注意二者区别，后者只能在比较粗的粒度进行控制。