基于Spring MVC的自定义标签Tag

1．环境准备

本次小项目基于Spring

MVC进行测试呈现，项目依赖的jar文件列表如下：

2．搭建SpringMVC

Spring

MVC环境最关键的两个配置文件为spring配置文件与web.xml文件，spring配置文件主要声明controller的拦截，视图的解析方式等。而web.xml主要是集成spring的一些拦截器配置，字符编码配置等。具体参考如下：

springmvc-servlet.xml：

web.xml：

编写第一个Controller：

TagsController.java

package com.keith.smvc.controller;

import org.springframework.stereotype.Controller;

import org.springframework.ui.Model;

import

org.springframework.web.bind.annotation.RequestMapping;

@Controller

public class TagsController {

@RequestMapping("/tags.do")

public

String getTagsPage(Model model) {

return "tags";

}

}

使用tomcat7运行该项目，项目正常启动，则表示Spring

MVC环节搭建已经成功。

3.编写自定义Tag标签

本次自定义的Tag标签，实现的是一个select下拉框，在实际很多项目中，下拉值集是比较常用的组件，而下拉值集的方式很多都定义为枚举，所以将其定义为一个tag标签，在开发过程中无疑将节省开发人员的很多编写代码时间，同时又能坐到复用，充分体现编程的高内聚、低耦合特性。

package com.keith.smvc.model;

public classEnumEntity {

private Long id;

private String enumCode;

private String enumValue;

private String enumTextCn;

private String enumTextEn;

private Integer

sortNumber;

private String description;

public Long getId() {

return id;

}

public void setId(Long

id)

{

this.id

=

id;

}

public String getEnumCode()

{

return enumCode;

}

public void setEnumCode(String

enumCode) {

this.enumCode

=

enumCode;

}

public String getEnumValue()

{

return enumValue;

}

public void setEnumValue(String

enumValue) {

this.enumValue

=

enumValue;

}

public String getEnumTextCn()

{

return enumTextCn;

}

public void setEnumTextCn(String

enumTextCn) {

this.enumTextCn

=

enumTextCn;

}

public String getEnumTextEn()

{

return enumTextEn;

}

public void setEnumTextEn(String

enumTextEn) {

this.enumTextEn

=

enumTextEn;

}

public Integer getSortNumber()

{

return sortNumber;

}

public void setSortNumber(Integer

sortNumber) {

this.sortNumber

=

sortNumber;

}

public String getDescription()

{

return description;

}

public void setDescription(String

description) {

this.description

=

description;

}

}

package

com.keith.smvc.service;

import

java.util.ArrayList;

import

java.util.List;

import

com.keith.smvc.model.EnumEntity;

public

class EnumService {

private List enumEntities = new ArrayList();

public List findEnumEntityAll() {

for (int i = 0; i < 5; i++) {

EnumEntity entity = new EnumEntity();

entity.setId(Long.valueOf(i + 1));

entity.setEnumCode("TEST_CODE_" + (i + 1));

entity.setEnumValue("TEST_VALUE_" + (i + 1));

entity.setEnumTextCn("测试枚举-"

+ (i + 1));

entity.setEnumTextEn("Test Enum " + (i + 1));

entity.setSortNumber((i + 1));

entity.setDescription("spring mvc self define tags.");

this.enumEntities.add(entity);

}

return this.enumEntities;

}

}

package com.keith.smvc.utils;

import org.apache.commons.lang3.RandomStringUtils;

public classPrimaryKeyUtils

{

public static Long

generateKeyByCountAndLength(int

count, int length)

{

StringBuffer key = new StringBuffer();

for (int

i =

0; i <

count; i++)

{

key.append(i

> 0 ?

generateByLength(length,

false) :

generateByLength(length,

true));

}

return Long.valueOf(key.toString());

}

public static String

generateByLength(int

length, boolean checkStartByZero) {

String key =

RandomStringUtils.randomNumeric(length);

return checkStartByZero &&

key.matches("^0\\d*$")

? generateByLength(length,

checkStartByZero) : key;

}

}

package

com.keith.smvc.tags;

import

java.util.HashMap;

import

java.util.List;

import

java.util.Map;

import

java.util.Map.Entry;

import

javax.servlet.jsp.JspException;

import

javax.servlet.jsp.JspTagException;

import

javax.servlet.jsp.tagext.BodyTagSupport;

import

javax.servlet.jsp.tagext.DynamicAttributes;

import

org.apache.commons.collections.CollectionUtils;

import

org.apache.commons.collections.MapUtils;

import

org.apache.commons.lang3.StringEscapeUtils;

import

org.apache.commons.lang3.StringUtils;

import

com.alibaba.fastjson.JSONObject;

import

com.alibaba.fastjson.serializer.SerializerFeature;

import

com.keith.smvc.model.EnumEntity;

import

com.keith.smvc.service.EnumService;

import

com.keith.smvc.utils.PrimaryKeyUtils;

public

class EnumTag extends BodyTagSupport implements DynamicAttributes

{

private static final long serialVersionUID =

3214120436850413923L;

private Map attributesMap = new HashMap();

@Override

public void setDynamicAttribute(String uri, String name, Object

value) throws JspException {

this.attributesMap.put(name, value);

}

private String buildSelectHTML() {

String superClass = "";

if (attributesMap.containsKey("class")) {

attributesMap.put("class", String.format("%s %s", superClass,

MapUtils.getString(attributesMap, "class")));

} else {

attributesMap.put("class", superClass);

}

if (!attributesMap.containsKey("id") &&

!attributesMap.containsKey("name")) {

Long key = PrimaryKeyUtils.generateKeyByCountAndLength(2,

4);

attributesMap.put("id", key);

attributesMap.put("name", key);

} else if (attributesMap.containsKey("id") &&

attributesMap.containsKey("name")) {

attributesMap.put("id", MapUtils.getString(attributesMap,

"id"));

attributesMap.put("name", MapUtils.getString(attributesMap,

"name"));

} else if (attributesMap.containsKey("id")) {

attributesMap.put("id", MapUtils.getString(attributesMap,

"id"));

} else if (attributesMap.containsKey("name")) {

attributesMap.put("name", MapUtils.getString(attributesMap,

"name"));

}

if (!attributesMap.containsKey("displayEmptyChoose")) {

attributesMap.put("displayEmptyChoose", true);

}

StringBuffer html = new StringBuffer();

html.append("--请选择--");

return html.toString();

}

private String convertTargetProperty() {

EnumService enumService = new EnumService();

ListenumEntities = enumService.findEnumEntityAll();

if (CollectionUtils.isEmpty(enumEntities)) {

return "";

}

return enumEntities.get(0).getEnumTextCn();

}

@Override

public int doStartTag() throws JspTagException {

return EVAL_BODY_BUFFERED;

}

@Override

public int doEndTag() throws JspTagException {

String type = MapUtils.getString(attributesMap, "type",

"SELECT");

String result = "";

try {

switch (type) {

case "SELECT":

result = this.buildSelectHTML();

break;

case "JSON":

result = JSONObject.toJSONString(new

EnumService().findEnumEntityAll(),

SerializerFeature.DisableCircularReferenceDetect);

break;

case "CONVERT":

result = this.convertTargetProperty();

break;

default:

break;

}

super.pageContext.getOut().print(result);

} catch (Exception e) {

throw new JspTagException(e.getMessage());

}

this.attributesMap.clear();

return SKIP_BODY;

}

}

如上为本次项目的所有用到的Java源码。

编写tag文件：

在项目的WEB-INF下新建一个文件夹：tld，在tld中新建tag文件framework.tld

<jsp-config>

<taglib>

<taglib-uri>/frameworktaglib-uri>

<taglib-location>/WEB-INF/tld/framework.tldtaglib-location>

taglib>

jsp-config>

编写测试的jsp页面：pages/tags.jsp

执行情况参见如下截图：

下拉框的change时间测试结果：