本文介绍自己最近做省市级联的类似的级联功能 的实现思路,为了尽可能地做到职责分离跟表现与行为分离,这个功能 拆分成了2个组件并用到了单链表来实现关键的级联逻辑,下一段有演示效果 的gif图。虽然这是个很常见的功能 ,但是本文的实现逻辑清晰,代码 好理解,脱离了省市级联这样的语义,考虑了表现与行为的分离,希望本文的内容 能够为你的工作带来一些参考的价值,欢迎阅读和指正。
Cascade 级联操作
CascadeType. PERSIST 级联持久化 ( 保存 ) 操作
CascadeType. MERGE 级联更新 ( 合并 ) 操作
CascadeType. REFRESH 级联刷新操作,只会查询 获取 操作
CascadeType. REMOVE 级联删除 操作
CascadeType. ALL 级联以上全部操作
Fetch 抓取是否延迟加载,默认情况一的方为立即加载,多的一方为延迟加载
mappedBy 关系维护
mappedBy= "parentid" 表示在children 类中的 parentid 属性 来维护关系,这个名称 必须和children 类中的 parentid属性 名称 完全一致才行。
另外需要注意,parent类中的集合类型必须是List或者Set,不能设置为ArrayList,否则会报错
演示效果 (代码 下载,注:该效果 需要http才能运行,另外效果 中的数据是模拟数据,并不是后台 真实返回的,所以看到的省市县的下拉数据都是一样的):
注:本文用到了前面几篇相关博客 的技术实现,如果有需要的话可以点击下面的链接 前去了解:
1)详解Javascript的继承实现:提供一个class.js,用来定义javascript的类和构建类的继承关系;
2)jquery技巧之让任何组件都支持 类似DOM的事件管理:提供一个eventBase.js,用来给任意组件实例提供类似DOM的事件管理功能 ;
3)对jquery的ajax进行二次封装以及ajax缓存代理组件:AjaxCache:提供ajax.js和ajaxCache.js,简化jquery的ajax调用 ,以及对请求进行客户端的缓存代理。
下面先来详细了解下这个功能 的要求。
1. 功能 分析
以包含三个级联项的级联组件来说明这个功能 :
1)每个级联项可能需要一个用作输入提示 的option:
这种情况每个级联项的数据列表中都能选择一个空的option(就是输入提示 的那个):
也可能不需要用作输入提示 的option:
这种情况每个级联项的数据列表中只能选数据option,选不到空的option:
2)如果当前这个页面 是从数据库 中查询 出来跟级联组件对应的字段有值,那么就把查询 出来的值回显到级联组件上:
如果查询 出来的对应字段没有值,那么就按第1)点需求描述的2种情况显示 。
3)各个级联项在数据结构上构成单链表的关系,后一个级联项的数据列表,跟前一个级联项所选择的数据有关联的。
4)考虑到性能 方面的问题,各个级联项的数据列表都采用ajax异步加载显示 。
5)在级联组件初始化完成以后,自动 加载第一个级联项的列表。
6)当前一个级联项发生改变时,清空后面所有直接或间接关联的级联项的数据列表,同时如果前一个级联项改变后的值不为空则自动 加载跟它直接关联的下一个级联项的数据列表。清空级联项的数据列表时要注意:如果级联项需要显示 输入提示 的option,在清空的时候得保留该option。
7)要充分考虑性能 问题,避免重复加载。
8)考虑到表单提交的问题,当级联组件任意级联项发生改变后,得把级联组件所选的值体现到一个隐藏的文本域内,方便把级联组件的值通过该文本域提交到后台 。
功能 大致如上。
2. 实现思路
1)数据结构
级联组件跟别的组件不太一样的是,它跟后台 的数据有一些依赖,我考虑的比较好实现的数据结构是:
id是数据的唯一标识,数据之间的关联关系通过parentId来构建,text,code这种都属于普通的业务字段。如果按这个数据结构,我们查询 级联项数据列表的接口就会变得很简单:
这个结构对于后台 来说也很好处理,虽然在结构上它们是一种树形的表结构,但是查询 都是单层的,所以很好实现。
从前面的查询 演示也能够看出,这个结构能够很方便地帮我们把数据查询 的接口和参数统一成一个,这对于组件开发来说是一个很方便的事情。我们从后台 拿到这个数据结构之后,把每一条数据解析成一个option,如北京市 ,这样既能完成数据列表的下拉显示 ,还能通过select这个表单元素的作用收集到当前级联项所选中的值,最后当级联项发生改变的时候,还能够获取 到选中的option,把它上面存储的data-param-value的值作为parentId这个参数,去加载下一个级联项的列表。这也是级联组件数据查询 和解析的思路。
但是这里面还需要考虑的是灵活性的问题,在实际的项目中,可能级联组件的数据结构是按id parentId这种类似的关联关系定义的,但是它们的字段不一定是叫id parentId text code,很有可能是别的字段。也就是说:在把数据解析成option的时候,option的text还有value到底用什么字段来解析,以及data-param-value这个属性 的用什么字段的值,都是不确定的;还有查询 数据时用的参数名称 parentId也不能是死的,有的时候如果后台 人员先写好了查询 接口,用了别的名称 ,你不可能要求人家去改他的参数名称 ,因为他那边是需要编译再部署的,相比前端更麻烦一些;还有parentId=0这个0值也是不能固定,因为实际项目中第一层的数据的parentid有可能是空,也有可能是-1。这些东西都得设计成option,一方面提供默认值,同时留给外部根据实际情况来设置,比如本文最终的实现中这个option都是这样定义的:
textField: 'text',//返回的数据中要在元素内显示 的字段名称
valueField: 'text',//返回的数据中要设置在 元素的value上的字段名称
paramField: 'id',//当调用 数据查询 接口时,要传递给后台 的数据对应的字段名称
paramName: 'parentId',//当调用 数据查询 接口时,跟在url后面传递数据的参数名
defaultParam: '',//当查询 第一个级联项时,传递给后台 的值,一般是0,'',或者-1等,表示要查询 第上层的数据
2)html结构
根据前面的功能 分析的第1条,级联组件的初始html结构有2种:
或
这两个结构唯一的区别就在于是否配置了用作输入提示 的option。另外需要注意的是如果需要这个空的option,一定得把value属性 设置成空,否则这个空的option在表单提交的时候会把option的提示 信息提交到后台 。
这两个结构最关键的是select元素,跟ul和li没有任何关系,ul跟li是为了UI而用到的;select元素没有任何语义,不用去标识哪个是省份,哪个是城市,哪个是区县。从功能 上来说,一个select代表一个级联项,这些select在哪定义都不重要,我们只要告诉级联组件,它的级联项由哪些select元素构成就行了,唯一需要额外告诉组件的就是这些select元素的先后关系,但是这个通常都是用元素在html中的默认顺序来控制的。这个结构能够帮助我们把组件的功能 尽可能地做到表现与行为分离。
3)职责分离和单链表的运用
从前面的部分也差不多能看出来了,这个级联组件如果按职责划分,可以分成两个核心的组件,一个负责整体功能 和内部级联项的管理(CascadeView),另一个负责级联项的功能 实现(CascadeItem)。另外为了更方便地实现级联的逻辑,我们只需要把所有的级联项通过链表连起来,通过发布-订阅 模式,后一个级联项订阅 前一个级联项发生改变的消息;当前面的级联项发生改变的时候,发布消息,通知 后面的级联项去处理相关逻辑;通过链表的作用,这个消息可能可以一直传递到最后一个级联项为止。用图来描述的话,大致就是这个样子:
我们需要做的就是控制好消息的发布跟传递。
4)表单提交
为了能够方便地将级联组件的值提交到后台 ,可以把整个级联组件当成一个整体,对外提供一个onChanged事件,外部可通过这个事件获取 所有级联项的值。由于存在多个级联项,所以在发布onChanged这个事件时,只能在任意级联项发生改变的时候,都去触发这个事件。
5)ajax缓存
在这个组件里面得考虑两个层级的ajax缓存,第一个是组件这一层级的,比如我把第一个级联项切换到了北京,这个时候第二个级联项就把北京的数据加载出来了,然后我把第一个级联项从北京切换到河北再切换到北京,这个时候第二个级联项要显示 的还是北京的关联数据列表,如果我们在第一次加载这个列表的时候就把它的数据缓存下来了,那么这次就不用发起ajax请求了;第二个是ajax请求这一层级的,假如页面 上有多个级联组件,我先把第一个级联组件的第一个级联项切换到北京,浏览器发起一个ajax请求加载数据,当我再把第二个级联组件的第一个级联项切换到北京的时候,浏览器还会再发一个请求去加载数据,如果我把第一个组件第一次ajax请求的返回的数据,先缓存起来,当第二个组件,用同样的参数请求同样的接口时,直接拿之前缓存觉得结果返回,这样也能减少一次ajax请求。第二个层级的ajax缓存依赖上文《对jquery的ajax进行二次封装以及ajax缓存代理组件:AjaxCache》,对于组件来说,它内部只实现了第一个层级的缓存,但是它不用考虑第二个层级的缓存,因为第二个层级的缓存实现对它来说是透明的,它不知道它用到的ajax组件有缓存的功能 。
3. 实现细节
最终的实现包含了三个组件,CascadeView、CascadeItem、CascadePublicDefaults,前面两个是组件的核心,最后一个只是用来定义一些option,它的作用在CascadeItem的注释里面有详细的描述。另外在下面的代码 中有非常详细的注释解释了一些关键代码 的作用,结合着前面的需求来看代码 ,应该还是比较容易理解的。我以前倾向于用文字 来解释一些实现细节,后来我慢慢觉得这种方式有点费力不讨好,第一是细节层面的语言不好组织,有的时候言不达意,明明想把一件事情解释清楚,结果反而弄得更加迷糊,至少我自己看自己写的东西就会这样的感触;第二是本身开发人员都具有阅读源码的能力,而且大部分积极的开发人员都愿意通过琢磨别人的代码 来理解实现思路;所以我改用注释的方式来说明实现细节:)
CascadePublicDefaults:
查询接口
textField: 'text',//返回的数据中要在
元素内显示 的字段名称
valueField: 'text',//返回的数据中要设置在 元素的value上的字段名称
paramField: 'id',//当调用 数据查询 接口时,要传递给后台 的数据对应的字段名称
paramName: 'parentId',//当调用 数据查询 接口时,跟在url后面传递数据的参数名
defaultParam: '',//当查询 第一个级联项时,传递给后台 的值,一般是0,'',或者-1等,表示要查询 第上层的数据
keepFirstOption: true,//是否保留第一个option(用作输入提示 ,如:请选择省份),如果为true,在重新加载级联项时,不会清除默认的第一个option
resolveAjax: function (res) {
return res;
}//因为级联项在加载数据的时候会发异步请求,这个回调用 来解析异步请求返回的响应
}
});
CascadeView:
获取所有级联项的值时使用的分隔符,如果是英文逗号,返回的值形如 北京市,区,朝阳区
values: '',//用valueSeparator分隔的字符串,表示初始时各个select的值
onChanged: $.noop //当任意级联项的值发生改变的时候会触发这个事件
});
var CascadeView = Class({
instanceMembers: {
init: function (options) {
//通过this.base
调用 父类 EventBase的init
方法
this.base();
var opts = this.options = this.getOptions(options),items = this.items = [],that = this,$elements = opts.$elements,values = opts.values.split(opts.valueSeparator);
this.on('changed.cascadeView',$.proxy(opts.onChanged,this));
$elements && $elements.each(function (i) {
var $el = $(this);
//实例化CascadeItem组件,并把每个实例的prevItem
属性 指向前一个实例
//第一个prevItem
属性 设置为undefined
var cascadeItem = new CascadeItem($el,$.extend(that.getItemOptions(),{
prevItem: i == 0 ? undefined : items[i - 1],value: $.trim(values[i])
}));
items.push(cascadeItem);
//每个级联项实例发生改变都会触发CascadeView组件的changed事件
//外部可在这个回调内处理业务逻辑
//比如将所有级联项的值设置到一个隐藏域里面,用于表单提交
cascadeItem.on('changed.cascadeItem',function () {
that.trigger('changed.cascadeView',that.getValue());
});
});
//初始化完成
自动 加载第一个级联项
items.length && items[0].load();
},getOptions: function (options) {
return $.extend({},this.getDefaults(),options);
},getDefaults: function () {
return DEFAULTS;
},getItemOptions: function () {
var opts = {},_options = this.options;
for (var i in PublicDefaults) {
if (PublicDefaults.hasOwnProperty(i) && i in _options) {
opts[i] = _options[i];
}
}
return opts;
},//
获取 所有级联项的值,是一个用valueSeparator分隔的字符串
//为空的级联项的值不会返回
getValue: function () {
var value = [];
this.items.forEach(function (item) {
var val = $.trim(item.getValue());
val != '' && value.push(val);
});
return value.join(this.options.valueSeparator);
}
},extend: EventBase
});
return CascadeView;
});
CascadeItem:
显示的value
});
var CascadeItem = Class({
instanceMembers: {
init: function ($el,options) {
//通过this.base
调用 父类 EventBase的init
方法
this.base($el);
this.$el = $el;
this.options = this.getOptions(options);
this.prevItem = this.options.prevItem; //前一个级联项
this.hasContent = false;//这个变量用来控制是否需要重新加载数据
this.cache = {};//用来缓存数据
var that = this;
//代理select元素的change事件
$el.on('change',function () {
that.trigger('changed.cascadeItem');
});
//当前一个级联项的值发生改变的时候,根据需要做清空和重新加载数据的处理
this.prevItem && this.prevItem.on('changed.cascadeItem',function () {
//只要前一个的值发生改变并且自身有
内容 的时候,就得清空
内容
that.hasContent && that.clear();
//如果不是第一个级联项,同时前一个级联项没有选中有效的option时,就不处理
if (that.prevItem && $.trim(that.prevItem.getValue()) == '') return;
that.load();
});
var value = $.trim(this.options.value);
value !== '' && this.one('render.cascadeItem',function () {
//设置初始值
that.$el.val(value.split(','));
//
通知 后面的级联项做清空和重新加载数据的处理
that.trigger('changed.cascadeItem');
});
},clear: function () {
var $el = this.$el;
$el.val('');
if (this.options.keepFirstOption) {
//保留第一个option
$el.children().filter(':gt(0)').remove();
} else {
//清空全部
$el.html('');
}
//
通知 后面的级联项做清空和重新加载数据的处理
this.trigger('changed.cascadeItem');
this.hasContent = false;//表示
内容 为空
},load: function () {
var opts = this.options,paramValue,dataKey;
//dataKey是在cache缓存时用的键名
//由于第一个级联项的数据是顶层数据,所以在缓存的时候用的是固定且唯一的键:root
//其它级联项的数据缓存时用的键名跟前一个选择的option有关
if (!this.prevItem) {
paramValue = opts.defaultParam;
dataKey = 'root';
} else {
paramValue = this.prevItem.getParamValue();
dataKey = paramValue;
}
//先看数据缓存中有没有加载过的数据,有就直接
显示 出来,避免Ajax
if (dataKey in this.cache) {
this.render(this.cache[dataKey]);
} else {
var params = {};
params[opts.paramName] = paramValue;
Ajax.get(opts.url,params).done(function (res) {
//resolveAjax这个回
调用 来在外部解析ajax返回的数据
//它需要返回一个data数组
var data = opts.resolveAjax(res);
if (data) {
that.cache[dataKey] = data;
that.render(data);
}
});
}
},render: function (data) {
var html = [],opts = this.options;
data.forEach(function (item) {
html.push(['
属性上
item[opts.paramField],'">',item[opts.textField],' '].join(''));
});
//采用append的方式动态
添加 ,避免影响第一个option
//最后还要把value设置为空
this.$el.append(html.join('')).val('');
this.hasContent = true;//表示有
内容
this.trigger('render.cascadeItem');
},getValue: function () {
return this.$el.val();
},getParamValue: function () {
return this.$el.find('option:selected').data('paramValue');
}
},extend: EventBase
});
return CascadeItem;
});
4. demo说明
演示代码 的结构:
其中框起来的就是演示的相关部分。html/regist.html是演示效果 的页面 ,js/app/regist.js是演示效果 的入口js:
注意以上代码 中LOCATION_VIEWS这个变量的作用,因为页面 上有多个级联组件,这个变量其实是通过策略模式,把各个组件的相关的东西都用一种类似的方式管理起来而已。如果不这么做的话,很容易产生重复代码 ;这种形式也比较有利于在入口文件 这种处理业务逻辑的地方,进行一些业务逻辑的分离与封装。
5. others
这估计是在现在公司写的最后一篇博客 ,过两天就得去新单位去上班了,不确定还能否有这么多空余的时间来记录平常的工作思路,但是好歹已经培养了写博客 的习惯,将来没时间也会挤出时间来的。今年的目标主要是拓宽知识面,提高代码 质量,后续的博客 更多还是在组件化开发这个类别上,希望以后能够得到大家的继续关注编程之家网站!