Lightning 实例：Lookup 组件

Lookup 组件

Visualforce 框架默认提供了设置 Lookup 字段的组件：

Visualforce 中的 Lookup 组件

而在 Lightning 框架中还没有类似的组件。

本文的目的是在 Lightning 框架中建立一个 Lookup 组件，从而让用户可以选择相关的对象记录，设置 Lookup 字段的值。

效果如下：（对客户对象进行搜索，并选择某一项）

初始状态：

初始状态

显示搜索结果：

显示搜索结果

选择某条记录：

选择某条记录

当然，具体的外观效果还需要进行提高。为了演示方便，我们只用了默认的 Lightning Design System 外观。

代码结构

在该组件包含以下几个部分：

  • Ltng_Lookup：核心组件，展示了组件的外观：搜索框和搜索按钮。为了保证搜索的灵活性，我们在其中设置一个 “provider” 属性，类型为 "Aura.Component[]"。这样，我们可以将搜索具体记录的逻辑封装在另一个组件中，并作为 “provider” 属性设置在核心组件里，从而分离了前后端逻辑
  • Ltng_Send_Provider_Parameter：事件，用于将用户的搜索字符串传递给后端
  • Ltng_Get_Provider_Result：事件，用于将后端的搜索结果传递给前端
  • Ltng_Lookup_Account_Provider：提供数据的组件。这类组件封装了后端操作相关的逻辑，并调用上面两个事件和核心组件进行通信，从而做到了对于核心组件的即插即用。一般情况下，每个组件对应一个对象类型。我们这里建立关于“客户（Accouont）”的搜索逻辑
  • Ltng_Send_SelectedId：事件，当用户在搜索结果中选择某项的时候，将被选择的记录的 ID 发送出去
  • Ltng_Lookup_Demo：演示用的组件，用于使用 Lookup 组件，并接收用户在其中选择的记录的 ID 值

代码执行流程

  1. 核心组件初始化的时候，加载设置好的提供数据的组件
  2. 用户在核心组件中输入字符，点击“搜索”按钮
  3. 核心组件调用控制器中的 “search” 函数，然后执行数据提供组件中的 Ltng_Send_Provider_Parameter 事件，将用户的输入发送出去
  4. 数据提供组件中已经定义了 Ltng_Send_Provider_Parameter 事件的处理函数，从而可以得到用户的输入，并调用 Apex 控制器来执行搜索
  5. 在数据提供组件得到搜索结果之后，执行 Ltng_Get_Provider_Result 事件，将搜索结果发送出去
  6. 在核心组件中已经定义了 Ltng_Get_Provider_Result 事件的处理函数，所以可以得到搜索结果，显示在列表中
  7. 用户可以点击任一记录进行选择，然后通过核心组件中的 Ltng_Send_SelectedId 事件将被选择的记录的 ID 发送给其他组件（比如包含了 Lookup 组件的外层组件）

完整代码

事件

Ltng_Send_Provider_Parameter：

<aura:event access="global" type="COMPONENT">
    <aura:attribute name="parameters" type="Object" access="public" />
</aura:event>

Ltng_Get_Provider_Result：

<aura:event access="global" type="COMPONENT">
    <aura:attribute name="data" type="Object" access="public" />
</aura:event>

Ltng_Send_SelectedId：

<aura:event access="global" type="COMPONENT">
    <aura:attribute name="selectedId" type="String" />
</aura:event>

上面三个事件中各包含一个属性，用于在组件之间传递值。

数据提供组件 Ltng_Lookup_Account_Provider

前端代码：

<aura:component controller="Ltng_Account_Controller">

    <!-- 注册两个事件，用于数据的发送和接收 -->
    <aura:registerEvent name="getProviderResult" type="c:Ltng_Get_Provider_Result" />
    <aura:registerEvent name="sendProvideParameter" type="c:Ltng_Send_Provider_Parameter" />
    
    <!-- 将发送数据的事件关联到控制器的 sendProvideParameter 函数 -->
    <aura:handler name="sendProvideParameter" action="{!c.sendProvideParameter}"  event="c:Ltng_Send_Provider_Parameter"/>

</aura:component>

控制器代码：

({
    sendProvideParameter : function(component, event, helper) {    
        var eventParams = event.getParams();
        var searchString = eventParams.parameters.searchString;

        // 调用 Apex 控制器的函数进行搜索
        var action = component.get("c.searchAccount");
        action.setParams({
            'searchString': searchString
        });
        action.setCallback(this, function(response) {
            var state = response.getState();
         
            if(state == "SUCCESS") {
                var result = response.getReturnValue();
               
                // 在得到搜索结果后，将其通过 getProviderResult 事件发送出去
                //   在核心组件中定义了相应的处理函数
                var dataChangeEvent = component.getEvent("getProviderResult");
                dataChangeEvent.setParams({
                      data: result
                });
                dataChangeEvent.fire();
            }
        });
        $A.enqueueAction(action);
    },
})

相关 Apex 控制器代码：

public with sharing class Ltng_Account_Controller {
    public class SearchResult {
        public String id {get;set;}
        public String value {get;set;}
    }
    
    @AuraEnabled
    public static String searchAccount(String searchString) {
        searchString = searchString + '%';

        List<Account> resultList = [SELECT Id, Name
                                        FROM Account
                                        WHERE Name LIKE :searchString];

        List<SearchResult> searchResults = new List<SearchResult>();

        for(Account res : resultList) {
            SearchResult sr = new SearchResult();
            sr.id = res.Id;
            sr.value = res.Name;

            searchResults.add(sr);
        }

        // 将搜索结果保存为 ID 和 Name 的列表，发送回 Lightning 组件中
        return JSON.serialize(searchResults);
    }
}

核心组件 Ltng_Lookup

外观如下：

<aura:component extensible="true">
    
    <!-- 初始化组件 -->
    <aura:handler name="init" value="{!this}" action="{!c.doInit}" />

    <!-- 数据提供组件属性 -->
    <aura:attribute name="provider" type="Aura.Component[]" access="public" description="Search provider" />

    <!-- 外观模板属性。当此组件被继承时，子组件可以重写该组件中定义了 template 的部分 -->
    <aura:attribute name="template" type="Aura.ComponentDefRef[]" access="public" />

    <aura:attribute name="searchString" type="String" access="public" />
    <aura:attribute name="searchResultList" type="List" access="public" />
    
    <aura:registerEvent name="LtngSendSelectedId" type="c:Ltng_Send_SelectedId" />
    
    <div class="slds">
        <div class="slds-form--inline">
            <div class="slds-form-element">                
                <ui:inputText aura:id="searchInput" class="slds-input" value="{!v.searchString}" />
            </div>
            
            <div class="slds-form-element">
                <button class="slds-button slds-button--brand" onclick="{!c.search}">
                    搜索
                </button>
            </div>
            
            <ul class="slds-has-dividers--top">
                <aura:iteration items="{!v.searchResultList}" var="searchResult" template="{!v.template}">
                    <li class="slds-item">
                        <button class="slds-button" onclick="{!c.makeSelection}" id="{!searchResult.id}" name="{!searchResult.value}">{!searchResult.value}</button>
                    </li>
                </aura:iteration>
            </ul>  
        </div>
        {!v.body}
    </div>
    
</aura:component>

控制器代码：

({
    doInit: function(component, event, helper) {
        var providers = component.get('v.provider') || [];
        var provider = providers[0];

        // 设定提供数据的组件中的 “getProviderResult” 事件的关联函数
        // 当提供数据的组件得到搜索结果后，将使用此组件中的 getProviderResult 函数来处理
        // 注意，event 的 register 和 handler 所在的组件必须相关联，
        //   所以不能提供数据的组件中静态的使用 <aura:handler> 来设置
        provider.addEventHandler("getProviderResult", component.getReference("c.getProviderResult"));
    },

    search : function(component, event, helper) {
        var providers = component.get('v.provider') || [];
        var provider = providers[0];

        // 调用提供数据的组件中注册的 “sendProvideParameter” 事件，
        //   将用户的输入发送出去，进行搜索
        provider.get('e.sendProvideParameter').setParams({
            parameters: {
                searchString: component.get('v.searchString')
            }
        }).fire();
    },

    getProviderResult: function(component, event, helper) {    
        // 从事件中得到搜索结果，并赋值给组件的属性
        var receivedData = JSON.parse( event.getParam('data') );
        component.set("v.searchResultList", receivedData);
    },
    
    makeSelection: function(component, event, helper) {
        var selectedId = event.target.id;
        var selectedName = event.target.name;
        component.set("v.searchString", selectedName);
        component.set('v.searchResultList', null);

        // 将选择的记录的 ID 的值发送给其他组件（使用该 Lookup 组件的组件）
        var compEvent = component.getEvent('LtngSendSelectedId');
        compEvent.setParams({
            selectedId: selectedId
        });
        compEvent.fire();
    },
})

演示用的组件 Ltng_Lookup_Demo

外观如下：

<aura:component >
    <aura:attribute name="selectedAccountId" type="String" access="public" />
    
    <aura:handler name="LtngSendSelectedId" event="c:Ltng_Send_SelectedId" action="{!c.getSelectedAccountId}" />
    
    <p>请搜索客户：</p>
    
    <!-- 直接设置 Lookup 组件相关联的数据提供组件 -->
    <c:Ltng_Lookup >
        <aura:set attribute="provider">
            <c:Ltng_Lookup_Account_Provider />
        </aura:set>
    </c:Ltng_Lookup>
    
    <p>选择的客户ID 是：{!v.selectedAccountId}</p>
</aura:component>

控制器代码：

({
    getSelectedAccountId: function(component, event, helper) {
        var selectedId = event.getParam('selectedId');
        component.set('v.selectedAccountId', selectedId);
    },
})
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 213,254评论 6赞 492
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 90,875评论 3赞 387
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 158,682评论 0赞 348
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 56,896评论 1赞 285
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 66,015评论 6赞 385
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 50,152评论 1赞 291
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,208评论 3赞 412
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,962评论 0赞 268
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,388评论 1赞 304
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,700评论 2赞 327
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,867评论 1赞 341
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,551评论 4赞 335
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,186评论 3赞 317
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,901评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,142评论 1赞 267
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 46,689评论 2赞 362
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 43,757评论 2赞 351

推荐阅读更多精彩内容