jQuery autoComplete插件-实现自动匹配

参数说明：

minChars (Number) : 在触发autoComplete钱用户至少需要输入的字符数 .Default:1 ,如果设为0，在输入框内双击或者删除输入框内内容时显示列表。

width (Number) : 指定下拉框的宽度 .Default: input元素的宽度。

max (Number) : autoComplete下拉显示项目的个数 .Default：10

delay (Number) : 点击激活autoComplete的延迟时间（单位毫秒） .Default:远程为400 本地10

autoFill (Boolean) : 要不要在用户选择时自动将用户当前鼠标所在的值填入到input框中.Default:false

mustMatch (Boolean) : 如果设置为true，autoComplete只会允许匹配的结果出现在输入框，所有当用户输入的是非法字符时将会得不到下拉框.Default:false

selectFirst (Boolean) : 如果设置成true，在用户键入tab或者return键时autoComplete下拉列表的第一个值将被自动选择，尽管它没有被手中选中（用鼠标或者键盘）。当然如果用户选中某个项目，那么就用用户选中的值 。Default:true

cacheLength (Number) : 缓存的长度，即对从数据库中取到的结果集要缓存多少条记录。设为1为不缓存. Default:10

matchSubset (Boolean) : autoComplete可不可以使用对服务器查询的缓存,如果缓存对foo的查询结果,那么如果用户输入foo就不需要再进行检索了,直接使用缓存.通常是打开这个选项以减轻服务器的负担以提高性能.只会在缓存长度大于1时有效.Default: true

matchCase (Boolean) : 比较是否开启大小写敏感开关.使用缓存时比较重要.如果你理解上一个选项,这个也就不难理解,就好比foot要不要到FOO的缓存中去找.Default: false

multiple (Boolean) : 是否允许输入多个值即多次使用autoComplete以输入多个值. Default: false

multipleSeparator (String) : 如果是多选时,用来分开各个选择的字符. Default: “,”

scroll (Boolean) : 当结果集大于默认高度时是否使用卷轴显示 Default: true

scrollHeight (Number) : 自动完成提示的卷轴高度用像素大小表示 Default: 180

formatItem (Function) : 为每个要显示的项目使用高级标签，即对结果中的每一行都会调用这个函数，返回值将用 LI 元素包含显示在下拉列表中。Autocompleter会提供三个参数（row, i, max）：返回的结果数组，当前处理的行数（即第几个项目，是从1开始的自然数），当前结果数组元素的个数即项目的个数。Default：none，表示不指定自定义的处理函数，这样下拉列表中的每一行只包含一个值。

formatResult (Function) : 和formatItem类似，但可以将要输入到input文本框内的值进行格式化，同样有三个参数，和formatItem一样.Default: none,表示要么是只有数据,要么是使用formatItem提供的值.

formatMatch (Function) : 对每一行数据使用此函数格式化需要查询的数据格式。返回值是给内部搜索算法使用的。参数值row

extraParams (Object) : 为后台（一般是服务器的脚本）提供更多的参数。和通常的做法是一样是使用一个键值对对象。如果传过去的值是{bar:4},将会被autocompleter解析成my_autocomplete_backend.php?q=foo&bar=4 (假设当前用户输入了foo). Default: {}

result (handler) Returns : jQuery 此事件会在用户选中某一项后触发，参数为（ event：事件对象。event.type为result。 data：选中的数据行. formattend：formatResult函数返回的值） 例如：

$("#singleBirdRemote").result(function(event, data, formatted) {
 //如选择后给其他控件赋值，触发别的事件等等
});

jQuery autoComplete插件两种使用方式

需要的导入的js文件和css文件：

<link
    href='<c:url value="/static/jquery-autocomplete/css/jquery.autocomplete.css"/>'
    rel="stylesheet" type="text/css" />
<script src='<c:url value="/static/jquery-autocomplete/js/jquery.js"/>'
    type="text/javascript" charset="utf-8"></script>
<script
    src='<c:url value="/static/jquery-autocomplete/js/jquery.autocomplete.min.js"/>'
    type="text/javascript" charset="utf-8"></script>

一次加载、多次使用：(这种方式是直接把后台查询到的所有数据一次性返回到浏览器，如果数据量很大的话，容易造成浏览器的栈溢出)

前端JS代码：

一次性获取到所有的城市信息：<input type="text" name="" id="allCity" onclick="$(this).click();"/>
    <input type="hidden" id="url_1" value='<c:url value="/"/>'/>

<script type="text/javascript">

    // 获取到全部的城市信息
    var url_ = $("#url_1").val();
    $(function(){
        $.ajax({
            url: url_+"/queryAllCityInfo",
            type: "post",
            dataType: "json",
            data:{},
            success: function(e){
                if(e.success){
                    $("#allCity").autocomplete(eval(e.data),{
                        max: 12,    //列表里的条目数
                        minChars: 0,    //自动完成激活之前填入的最小字符
                        width: 218,     //提示的宽度，溢出隐藏
                        scrollHeight: 300,   //提示的高度，溢出显示滚动条
                        matchContains: true,    //包含匹配，就是data参数里的数据，是否只要包含文本框里的数据就显示
                        autoFill: false,    //自动填充
                        formatItem: function(row, i, max) {
                            return row.name;
                        },
                        formatMatch: function(row, i, max) {
                            return row.name;
                        },
                        formatResult: function(row) {
                            return row.name;
                        }
                    }).result(function(event,item){

                    });
                }
            }
        });
    });
</script>

二、根据输入内容动态加载：
前端js代码：

所处城市：<input type="text" name="searchStr" id="searchStr">
    <input type="hidden" id="url_" value='<c:url value="/queryCityName"/>'/>
<script type="text/javascript">
    var url = $("#url_").val();

    // 实时的更新列表中的条目信息
    $("#searchStr").autocomplete(url, {
        max : 8, // 列表里的条目数
        minChars : 0, // 自动完成激活之前填入的最小字符
        width : 200, // 提示的宽度，溢出隐藏
        matchContains : true, // 包含匹配，就是data参数里的数据，是否只要包含文本框里的数据就显示
        autoFill : false, // 自动填充
        cacheLength : 0, // 清除缓存 
        extraParams : {
            searchStr : function() {
                return $("#searchStr").val();
            }
        },
        parse : function(data) {
            var json = eval("("+data+")"); //一般返回的都是字符串，需要对其对象化
            if (json.success) {
                var parsed = [];
                var rows = json.nameList;               
                for (var i = 0; i < rows.length; i++) {
                    var name = rows[i].split("|"); // 使用Jquery中的autoComplete插件实现自动匹配功能时，直接使用它来解析json对象时，会出现一个错误提示，
                    //因为它默认使用"/n"拆分行、"|"拆分字段。如果需要使用它来解析json对象，则需要自己实现其parse方法。
                    parsed[parsed.length] = {
                        data : name, //下拉框显示数据格式
                        value : name, //选定后实际数据格式
                        result : name //选定后输入框显示数据格式
                    };
                }
                return parsed;
            }
        }
    }).result(function(event, item, data) { // 回调函数

         // data->相当于 value的值
    });
</script>

注：使用Jquery中的autoComplete插件实现自动匹配功能时，直接使用它来解析json对象时，会出现一个错误提示，因为它默认使用”/n”拆分行、”|”拆分字段。如果需要使用它来解析json对象，则需要自己实现其parse方法。

使用动态加载时，添加了两个参数，searchStr，和 limit ，所有 实体对象中要额外添加两个字段，前端通过extraParams （searchStr），和 max（limit）属性来返回给服务器。

这里再添加 mybatis中的 sql 查询语句：

<select id="queryCityName" parameterType="com.zhihua.entity.CityInfo" resultMap="BaseResultMap">
        <!-- <bind name="search" value="'%' + searchStr + '%'" /> -->
        select * from 
        (select a.id,a.code,a.name 
            from cityinfo a
            where 1=1 
            <if test="searchStr!=null and searchStr!=''">
            and name LIKE CONCAT(CONCAT('%', #{searchStr,jdbcType=VARCHAR}), '%') 
            </if>
            order by code asc 
        )b 
          where 1=1 limit #{limit} 
    </select>

效果图：