cn.hutool.core.text.NamingCase Maven / Gradle / Ivy
package cn.hutool.core.text;
import cn.hutool.core.util.CharUtil;
import cn.hutool.core.util.StrUtil;
/**
* 命名规则封装，主要是针对驼峰风格命名、连接符命名等的封装
*
* @author looly
* @since 5.7.10
*/
public class NamingCase {
/**
* 将驼峰式命名的字符串转换为下划线方式，又称SnakeCase、underScoreCase。
* 如果转换前的驼峰式命名的字符串为空，则返回空字符串。
* 规则为：
*
* - 单字之间以下划线隔开
* - 每个单字的首字母亦用小写字母
*
* 例如：
*
*
* HelloWorld=》hello_world
* Hello_World=》hello_world
* HelloWorld_test=》hello_world_test
*
*
* @param str 转换前的驼峰式命名的字符串，也可以为下划线形式
* @return 转换后下划线方式命名的字符串
*/
public static String toUnderlineCase(CharSequence str) {
return toSymbolCase(str, CharUtil.UNDERLINE);
}
/**
* 将驼峰式命名的字符串转换为短横连接方式。
* 如果转换前的驼峰式命名的字符串为空，则返回空字符串。
* 规则为：
*
* - 单字之间横线线隔开
* - 每个单字的首字母亦用小写字母
*
* 例如：
*
*
* HelloWorld=》hello-world
* Hello_World=》hello-world
* HelloWorld_test=》hello-world-test
*
*
* @param str 转换前的驼峰式命名的字符串，也可以为下划线形式
* @return 转换后下划线方式命名的字符串
*/
public static String toKebabCase(CharSequence str) {
return toSymbolCase(str, CharUtil.DASHED);
}
/**
* 将驼峰式命名的字符串转换为使用符号连接方式。如果转换前的驼峰式命名的字符串为空，则返回空字符串。
*
* @param str 转换前的驼峰式命名的字符串，也可以为符号连接形式
* @param symbol 连接符
* @return 转换后符号连接方式命名的字符串
* @since 4.0.10
*/
public static String toSymbolCase(CharSequence str, char symbol) {
if (str == null) {
return null;
}
final int length = str.length();
final StrBuilder sb = new StrBuilder();
char c;
for (int i = 0; i < length; i++) {
c = str.charAt(i);
if (Character.isUpperCase(c)) {
final Character preChar = (i > 0) ? str.charAt(i - 1) : null;
final Character nextChar = (i < str.length() - 1) ? str.charAt(i + 1) : null;
if (null != preChar) {
if (symbol == preChar) {
// 前一个为分隔符
if (null == nextChar || Character.isLowerCase(nextChar)) {
//普通首字母大写，如_Abb -> _abb
c = Character.toLowerCase(c);
}
//后一个为大写，按照专有名词对待，如_AB -> _AB
} else if (Character.isLowerCase(preChar)) {
// 前一个为小写
sb.append(symbol);
if (null == nextChar || Character.isLowerCase(nextChar) || CharUtil.isNumber(nextChar)) {
//普通首字母大写，如aBcc -> a_bcc
c = Character.toLowerCase(c);
}
// 后一个为大写，按照专有名词对待，如aBC -> a_BC
} else {
//前一个为大写
if (null != nextChar && Character.isLowerCase(nextChar)) {
// 普通首字母大写，如ABcc -> A_bcc
sb.append(symbol);
c = Character.toLowerCase(c);
}
// 后一个为大写，按照专有名词对待，如ABC -> ABC
}
} else {
// 首字母，需要根据后一个判断是否转为小写
if (null == nextChar || Character.isLowerCase(nextChar)) {
// 普通首字母大写，如Abc -> abc
c = Character.toLowerCase(c);
}
// 后一个为大写，按照专有名词对待，如ABC -> ABC
}
}
sb.append(c);
}
return sb.toString();
}
/**
* 将下划线方式命名的字符串转换为帕斯卡式。
* 规则为：
*
* - 单字之间不以空格或任何连接符断开
* - 第一个单字首字母采用大写字母
* - 后续单字的首字母亦用大写字母
*
* 如果转换前的下划线大写方式命名的字符串为空，则返回空字符串。
* 例如：hello_world=》HelloWorld
*
* @param name 转换前的下划线大写方式命名的字符串
* @return 转换后的驼峰式命名的字符串
*/
public static String toPascalCase(CharSequence name) {
return StrUtil.upperFirst(toCamelCase(name));
}
/**
* 将下划线方式命名的字符串转换为驼峰式。如果转换前的下划线大写方式命名的字符串为空，则返回空字符串。
* 规则为：
*
* - 单字之间不以空格或任何连接符断开
* - 第一个单字首字母采用小写字母
* - 后续单字的首字母亦用大写字母
*
* 例如：hello_world=》helloWorld
*
* @param name 转换前的下划线大写方式命名的字符串
* @return 转换后的驼峰式命名的字符串
*/
public static String toCamelCase(CharSequence name) {
return toCamelCase(name, CharUtil.UNDERLINE);
}
/**
* 将连接符方式命名的字符串转换为驼峰式。如果转换前的下划线大写方式命名的字符串为空，则返回空字符串。
*
* @param name 转换前的自定义方式命名的字符串
* @param symbol 原字符串中的连接符连接符
* @return 转换后的驼峰式命名的字符串
* @since 5.7.17
*/
public static String toCamelCase(CharSequence name, char symbol) {
return toCamelCase(name, symbol, true);
}
/**
* 将连接符方式命名的字符串转换为驼峰式。如果转换前的下划线大写方式命名的字符串为空，则返回空字符串。
*
* @param name 转换前的自定义方式命名的字符串
* @param symbol 原字符串中的连接符连接符
* @param otherCharToLower 其他非连接符后的字符是否需要转为小写
* @return 转换后的驼峰式命名的字符串
*/
public static String toCamelCase(CharSequence name, char symbol, boolean otherCharToLower) {
if (null == name) {
return null;
}
final String name2 = name.toString();
if (StrUtil.contains(name2, symbol)) {
final int length = name2.length();
final StringBuilder sb = new StringBuilder(length);
boolean upperCase = false;
for (int i = 0; i < length; i++) {
char c = name2.charAt(i);
if (c == symbol) {
upperCase = true;
} else if (upperCase) {
sb.append(Character.toUpperCase(c));
upperCase = false;
} else {
sb.append(otherCharToLower ? Character.toLowerCase(c) : c);
}
}
return sb.toString();
} else {
return name2;
}
}
}