salesforce lightning零基礎學習(十六) 公用組件之 獲取字段label信息

我們做的項目好多都是多語言的項目，針對不同國家需要展示不同的語言的標題。我們在classic中的VF page可謂是得心應手，因為系統中已經封裝好了我們可以直接在VF獲取label/api name等方法。但是我們在lightning aura中開發卻發現這個常用的功能並沒有包含，好吧，既然沒有現成可用的那我們就要有workaround的方式去后台獲取。此篇主要封裝好組件去實現獲取某個object或者某些object相關字段的label。

那我們來開始進行這個組件的開發，開發以前我們需要先思考一下，組件化的東西，傳參應該是什么，返回應該是什么，應該實現哪些功能解決哪些痛點。如何用到更好的優化。本人思考可能並不特別的完全，感興趣的可以進行優化。

1. object 的API name應該為必填項。 這里應該實現可以同時獲取多個表的字段的label信息，我們畫component時，很可能需要獲取當前的對象，父對象以及相關的子對象的字段的label，所以此處傳參應該能做到傳遞list而不是單一的object

2. object對應的指定的field的api name列表，此項應該為可選項，非必填。我們都知道aura開發現在很慢，而且我們在前台獲取label時，可能一個object有上百個字段，但是我們在頁面只需要某幾個字段的label的信息，如果全部查出來放在前台特別影響view state，所以我們此處應該支持可以通過指定的一些字段進行查詢。因為object傳參是list,所以此參數應該為Map<String,List<String>>方式。

3. 返回類型應該為 Map<String,Map<String,String>>類型，外層的key是objectAPIName，內層的map的key是fieldAPIName,內層的map的value為我們需要的field label

OK，上面的已經梳理出來，那干就完了。

一. 公用組件搭建

FieldLabelServiceController.cls 用於后台搭建查詢指定的obj / field的value -> label信息

public with sharing class FieldLabelServiceController {
    /*
    * @param objApiNameList : object API name list. eg:['Account','Contact']
    * @param objApiName2FieldsMap: object API name 2 fields map. eg:{'Account':['Name','Type'],'Contact':['LastName','Phone']}
    * @return object API name 2 map of field API name -> label name. eg:{'Account':{'Type'：'類型'},'Contact':{'LastName':'姓'}}
    */
    @AuraEnabled
    public static Map<String,Map<String,String>> getFieldLabelService(List<String> objApiNameList,Map<String,List<String>> objApiName2FieldsMap) {
        // key: object API name ; value : (Map: key:field API name, value: field label)
        Map<String,Map<String,String>> object2FieldLabelMap = new Map<String,Map<String,String>>();
        //get all sobject sObjectType map
        Map<String,sObjectType> objName2ObjTypeMap = Schema.getGlobalDescribe();
        for(String objApiName : objApiNameList) {

            //1. get specific object sObjectType
            sObjectType objType = objName2ObjTypeMap.get(objApiName);
            //2. get all of the fields map via specific object
            Map<String,Schema.SObjectField> fieldsMap = objType.getDescribe().fields.getMap();

            //3. check if retrieve specific field list or all the fields mapping via object
            Set<String> retrieveFieldList = new Set<String>();
            if(objApiName2FieldsMap != null && objApiName2FieldsMap.containsKey(objApiName)) {
                retrieveFieldList = new Set<String>(objApiName2FieldsMap.get(objApiName));
            }

            Map<String,String> fieldApiName2FieldLabelMap = new Map<String,String>();
            //4. get all / specific field api name -> label name mapping
            for(String fieldApiName : fieldsMap.keySet()){
                if(retrieveFieldList.size() > 0 && !retrieveFieldList.contains(String.valueOf(fieldsMap.get(fieldApiName)))) {30                     continue;
                }

                String label = fieldsMap.get(fieldApiName).getDescribe().getLabel();
                fieldApiName2FieldLabelMap.put(String.valueOf(fieldsMap.get(fieldApiName)), label == null ? fieldApiName : label);
            }

            object2FieldLabelMap.put(objApiName, fieldApiName2FieldLabelMap);
        }
        return object2FieldLabelMap;
    }
}

FieldLabelService.cmp:用於封裝共用方法

<aura:component access="global" description="Field label service" controller="FieldLabelServiceController">
    <aura:method access="global" name="getFieldLabel" action="{!c.getFieldLabelAction}">
        <aura:attribute type="List" name="objectAPINameList" required="true" description="object list to retrieve field label" />
        <aura:attribute type="Map" name="objectFieldAPINameMap" description="specific fields need to retrieve via object api name"/>
        <aura:attribute type="Function" name="callback" required="true" />
    </aura:method>
</aura:component> 

FieldLabelServiceController.js：用於封裝對應的controller js方法，調用后台獲取結果

({
    getFieldLabelAction : function(component, event, helper) {
        const params = event.getParam('arguments');
        const action = component.get('c.getFieldLabelService');
        action.setParams({
            "objApiNameList" : params.objectAPINameList,
            "objApiName2FieldsMap":params.objectFieldAPINameMap
        });
        action.setCallback(this, function(response) {
            const state = response.getState();
            if (state === 'SUCCESS') {
                params.callback(response.getReturnValue());
            } else if (state === 'ERROR') {
                const errors = response.getError();
                if (errors) {
                    console.error(JSON.stringify(errors));
                } else {
                    console.error('Unknown error');
                }
            }
        });

        $A.enqueueAction(action);
    }
})

至此組件封裝完成，下面是調用部分。調用部分沒有UI，感興趣的自行畫UI。

二. 公用組件測試

FieldLabelTestComponent：用於引入公用組件，並且初始化獲取Account/Contact的field label。

<aura:component implements="flexipage:availableForAllPageTypes">
    <aura:handler name="init" value="{!this}" action="{!c.doInit}"/>
    <aura:attribute name="accountFieldLabelMap" type="Map"/>
    <aura:attribute name="contactFieldLabelMap" type="Map"/>
    <c:FieldLabelService aura:id="service"/>
</aura:component>

FieldLabelTestComponentController.js：用於后台調用公用組件的方法，傳值，針對response進行解析獲取自己需要的內容。demo中針對account只獲取name以及type的值，對contact獲取所有字段的label值。

({
    doInit : function(component, event, helper) {
        const service = component.find('service');
        let objectAPINameList = ['Account','Contact'];
        let objectFieldAPINameMap = {'Account':['Name','Type']};
        service.getFieldLabel(objectAPINameList,objectFieldAPINameMap,function(result) {
            console.log(JSON.stringify(result));
            component.set('v.accountFieldLabelMap',result['Account']);
            component.set('v.contactFieldLabelMap',result['Contact']);
            console.log(JSON.stringify(result['Account']));
            console.log(JSON.stringify(result.Account));
        });
    }
})

結果展示：針對account只獲取了指定的字段的label，Contact獲取了所有的label信息。可以使用[]方式或者.的方式獲取詳細內容。

 總結：篇中簡單的介紹了針對aura情況下獲取field label的公用組件的實現。篇中有錯誤的地方歡迎指出，有不懂的歡迎留言，有可以優化的地方歡迎交流並且鼓勵優化。