shade.com.alibaba.fastjson2.PropertyNamingStrategy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dingtalk-stream Show documentation
There is a newer version: 1.3.7
package com.alibaba.fastjson2;

import com.alibaba.fastjson2.util.BeanUtils;

/**
 * An enumeration that defines a few standard naming conventions for JSON field names.
 * @since 1.2.15
 */
public enum PropertyNamingStrategy {
    CamelCase,
    /**
     * for fastjson 1.x compatible
     */
    CamelCase1x,
    /**
     * Using this naming policy with FASTJSON will ensure that the first "letter" of the Java field name is capitalized when serialized to its JSON form.
     * Here are a few examples of the form "Java Field Name" ---> "JSON Field Name":
     * someFieldName ---> SomeFieldName
     * _someFieldName ---> _SomeFieldName
     */
    PascalCase,
    SnakeCase,
    UpperCase,
    /**
     * Using this naming policy with FASTJSON will ensure that the first "letter" of the Java field name is capitalized when serialized to its JSON form and the words will be separated by a space.
     * Here are a few examples of the form "Java Field Name" ---> "JSON Field Name":
     * someFieldName ---> Some Field Name
     * _someFieldName ---> _Some Field Name
     * @since 2.0.7
     */
    UpperCamelCaseWithSpaces,
    /**
     * Using this naming policy with FASTJSON will ensure that the first "letter" of the Java field name is capitalized when serialized to its JSON form and the words will be separated by an underscore (_).
     * Here are a few examples of the form "Java Field Name" ---> "JSON Field Name":
     * someFieldName ---> Some_Field_Name
     * _someFieldName ---> _Some_Field_Name
     * @since 2.0.7
     */
    UpperCamelCaseWithUnderScores,
    /**
     * Using this naming policy with FASTJSON will ensure that the first "letter" of the Java field name is capitalized when serialized to its JSON form and the words will be separated by a dash (-).
     * Here are a few examples of the form "Java Field Name" ---> "JSON Field Name":
     * someFieldName ---> Some-Field-Name
     * _someFieldName ---> _Some-Field-Name
     * @since 2.0.7
     */
    UpperCamelCaseWithDashes,
    /**
     * Using this naming policy with FASTJSON will ensure that the first "letter" of the Java field name is capitalized when serialized to its JSON form and the words will be separated by a dash (-).
     * Here are a few examples of the form "Java Field Name" ---> "JSON Field Name":
     * someFieldName ---> Some-Field-Name
     * _someFieldName ---> _Some-Field-Name
     * @since 2.0.7
     */
    UpperCamelCaseWithDots,
    /**
     * Using this naming policy with FASTJSON will modify the Java Field name from its camel cased form to a lower case field name where each word is separated by a dash (-).
     * Here are a few examples of the form "Java Field Name" ---> "JSON Field Name":
     * someFieldName ---> some-field-name
     * _someFieldName ---> _some-field-name
     * aStringField ---> a-string-field
     * aURL ---> a-u-r-l
     * Using dashes in JavaScript is not recommended since dash is also used for a minus sign in expressions. This requires that a field named with dashes is always accessed as a quoted property like myobject['my-field']. Accessing it as an object field myobject.my-field will result in an unintended javascript expression.
     */
    KebabCase,
    /**
     * Using this naming policy with FASTJSON will modify the Java Field name from its camel cased form to an upper case field name where each word is separated by an underscore (_).
     * Here are a few examples of the form "Java Field Name" ---> "JSON Field Name":
     * someFieldName ---> SOME_FIELD_NAME
     * _someFieldName ---> _SOME_FIELD_NAME
     * aStringField ---> A_STRING_FIELD
     * aURL ---> A_U_R_L
     * @since 2.0.7
     */
    UpperCaseWithUnderScores,
    /**
     * Using this naming policy with FASTJSON will modify the Java Field name from its camel cased form to an upper case field name where each word is separated by a dash (-).
     * Here are a few examples of the form "Java Field Name" ---> "JSON Field Name":
     * someFieldName ---> SOME-FIELD-NAME
     * _someFieldName ---> _SOME-FIELD-NAME
     * aStringField ---> A-STRING-FIELD
     * aURL ---> A-U-R-L
     * @since 2.0.8
     */
    UpperCaseWithDashes,
    /**
     * Using this naming policy with FASTJSON will modify the Java Field name from its camel cased form to an upper case field name where each word is separated by a dot (.).
     * Here are a few examples of the form "Java Field Name" ---> "JSON Field Name":
     * someFieldName ---> SOME.FIELD.NAME
     * _someFieldName ---> _SOME.FIELD.NAME
     * aStringField ---> A.STRING.FIELD
     * aURL ---> A.U.R.L
     * @since 2.0.8
     */
    UpperCaseWithDots,
    LowerCase,
    /**
     * Using this naming policy with FASTJSON will modify the Java Field name from its camel cased form to a lower case field name where each word is separated by an underscore (_).
     * Here are a few examples of the form "Java Field Name" ---> "JSON Field Name":
     * someFieldName ---> some_field_name
     * _someFieldName ---> _some_field_name
     * aStringField ---> a_string_field
     * aURL ---> a_u_r_l
     * @since 2.0.7
     */
    LowerCaseWithUnderScores,
    /**
     * Using this naming policy with FASTJSON will modify the Java Field name from its camel cased form to a lower case field name where each word is separated by a dash (-).
     * Here are a few examples of the form "Java Field Name" ---> "JSON Field Name":
     * someFieldName ---> some-field-name
     * _someFieldName ---> _some-field-name
     * aStringField ---> a-string-field
     * aURL ---> a-u-r-l
     * Using dashes in JavaScript is not recommended since dash is also used for a minus sign in expressions. This requires that a field named with dashes is always accessed as a quoted property like myobject['my-field']. Accessing it as an object field myobject.my-field will result in an unintended javascript expression.
     * @since 2.0.7
     */
    LowerCaseWithDashes,
    /**
     * Using this naming policy with FASTJSON will modify the Java Field name from its camel cased form to a lower case field name where each word is separated by a dot (.).
     * Here are a few examples of the form "Java Field Name" ---> "JSON Field Name":
     * someFieldName ---> some.field.name
     * _someFieldName ---> _some.field.name
     * aStringField ---> a.string.field
     * aURL ---> a.u.r.l
     * Using dots in JavaScript is not recommended since dot is also used for a member sign in expressions. This requires that a field named with dots is always accessed as a quoted property like myobject['my.field']. Accessing it as an object field myobject.my.field will result in an unintended javascript expression.
     * @since 2.0.7
     */
    LowerCaseWithDots,
    NeverUseThisValueExceptDefaultValue;

    public String fieldName(String name) {
        return BeanUtils.fieldName(name, this.name());
    }

    public static String snakeToCamel(String name) {
        if (name == null || name.indexOf('_') == -1) {
            return name;
        }

        int underscoreCount = 0;
        for (int i = 0; i < name.length(); i++) {
            char ch = name.charAt(i);
            if (ch == '_') {
                underscoreCount++;
            }
        }

        char[] chars = new char[name.length() - underscoreCount];
        for (int i = 0, j = 0; i < name.length(); i++) {
            char ch = name.charAt(i);
            if (ch == '_') {
                continue;
            }
            if (i > 0 && name.charAt(i - 1) == '_') {
                if (ch >= 'a' && ch <= 'z') {
                    ch -= 32;
                }
            }
            chars[j++] = ch;
        }

        return new String(chars);
    }
}