當解析複雜的json結構時，ognl是一個很方便的工具，實現基於圖對屬性的訪問，類似於以(user.name | user.depart[0])的方式獲取json內的巢狀物件欄位值。

請看以下示例，你將對ognl的作用有一個更清晰的理解：

String json = "{\"user\":{\"name\":\"123\",\"depart\":[1,2]}}";
Map<?, ?> map = JacksonHelper.fromJson(json, Map.class);
OgnlWrapper ognlWrapper = new OgnlWrapper(map);
System.err.println(ognlWrapper.get("user.name"));
System.err.println(ognlWrapper.get("user.depart.size"));
System.err.println(ognlWrapper.get("user.depart[0]"));
 

• 內部物件的普通欄位可以通過user.name這樣的方式獲取
• 內部物件的集合欄位可以通過user.depart.size獲取其集合長度
• 內部物件的集合欄位可以通過user.depart[0]的方式獲取對應下標出的值

通常json物件解析可以通過一層一層的轉換為map來實現，但如果巢狀物件層次有3層以上，內部結構較複雜，那實現起來就很繁瑣，程式碼冗長，這種情況下使用ognl能讓程式碼精簡很多。

1、新增maven依賴

<!-- ognl -->
<dependency>
    <groupId>ognl</groupId>
    <artifactId>ognl</artifactId>
    <version>3.2.1</version>
</dependency>
 

2、OgnlWrapper

@SuppressWarnings("unchecked")
public class OgnlWrapper {

    private static Logger logger = LoggerFactory.getLogger(OgnlWrapper.class);

    private static ObjectMapper om = new ObjectMapper();
    private Map<String, Object> payload;

    public OgnlWrapper(Map<String, Object> playload) {
        Validate.notEmpty(playload, "can not construct with none playload!");
        this.payload = playload;
    }


    public OgnlWrapper(Object playload) {
        this.payload = om.convertValue(playload, Map.class);
    }

    public <T> T get(String expression) {
        try {
            return (T) Ognl.getValue(expression, this.payload);
        } catch (OgnlException e) {
            logger.trace(String.format("get value with expression:[%s] due to error, return null instead of",
                expression), e);
            return null;
        }
    }

    public Long getLong(String expression) {
        try {
            Object obj = Ognl.getValue(expression, this.payload);
            if (null == obj)
                return null;
            try {
                return Long.parseLong(obj.toString());
            } catch (NumberFormatException nfe) {
                logger.warn(String.format("get value with expression:[%s] due to error, return null. value[%s] cannot be cast to java.lang.Long",
                    expression,
                    obj.toString()));
                return null;
            }
        } catch (OgnlException e) {
            logger.trace(String.format("get value with expression:[%s] due to error, return null instead of",
                expression), e);
            return null;
        }
    }

    public Integer getInt(String expression) {
        try {
            Object obj = Ognl.getValue(expression, this.payload);
            if (null == obj)
                return null;
            try {
                return Integer.parseInt(obj.toString());
            } catch (NumberFormatException nfe) {
                logger.warn(String.format("get value with expression:[%s] due to error, return null. value[%s] cannot be cast to java.lang.Integer",
                    expression,
                    obj.toString()));
                return null;
            }
        } catch (OgnlException e) {
            logger.trace(String.format("get value with expression:[%s] due to error, return null instead of",
                expression), e);
            return null;
        }
    }

    @Override
    public String toString() {
        return String.format("OgnlWrapper[%s]", this.payload.toString());
    }

    public static void main(String[] args) {
        String json = "{\"user\":{\"name\":\"123\",\"depart\":[1,2]}}";
        Map<?, ?> map = JacksonHelper.fromJson(json, Map.class);
        OgnlWrapper ognlWrapper = new OgnlWrapper(map);
        System.err.println(ognlWrapper.get("user.name"));
        System.err.println(ognlWrapper.get("user.depart.size"));
        System.err.println(ognlWrapper.get("user.depart[0]"));
    }
}
 

3、使用手冊

說明

OgnlWrapper是基於ognl.Ognl類的一個工具類，實現基於圖對屬性的訪問，支援ognl的所有語法。 提供三個核心方法:
get();
getLong(); //如果值非long型，將返回null
getInt(); //如果值非int型，將返回null

使用注意

在使用Long longvalue = ognlWrapper.get(“body.payload.page.page_size”); 時出現如下錯誤: java.lang.ClassCastException: java.lang.Long cannot be cast to java.lang.Integer
解決方法:使用getLong方法
Long longvalue = ognlWrapper.getLong(“body.payload.page.page_size”);

獲取不存在的屬性時返回null，日誌中會列印warn警告日誌。 如:ognlWrapper.getLong(“body.payload[0].childrens[0].childrens.size”); // return null

單個物件

User user = new User(); //設定使用者的相關屬性
//...省略屬性設定
//使用OgnlWrapper
OgnlWrapper ognlWrapper = new OgnlWrapper(user);
String id = ognlWrapper.get("id");//獲取id

//狀態. 請使用基本資料型別的封裝型別
Integer status = ognlWrapper.getInt("status");  
//聯絡資訊中的郵件地址
String email = ognlWrapper.get("contact_info.email");

//獲取一個不存在的屬性
//將返回null
String noexist = ognlWrapper.get("noexist");

//將返回null
noexist = ognlWrapper.get("contact_info.noexist");

對list操作

//將存放使用者的列表資料放到map中 map.put("users",list);
//使用OgnlWrapper獲取使用者列表資料
OgnlWrapper ognlWrapper = new OgnlWrapper(map);

//獲取list大小。如果map未存放list則返回null
Integer size = ognlWrapper.getInt("users.size"); 
if(null == size || 0 == size.intValue())  return ;

//獲取list中第一使用者的使用者id和name 注意:下標從0開始
String id = ognlWrapper.get("users[0].id");
String name = ognlWrapper.get("users[0].name");

//如果索引超出list的大小，將返回null
String nullvalue = ognlWrapper.get("users[9999999].id");    

使用OgnlWrapper獲取屬性值時，請使用物件型別。如int 使用Integer型別。

完整程式碼請參考github內rest-base專案com.onecoderspace.base.util.ognl.OgnlWrapper。
https://github.com/q7322068/rest-base