框架工具类使用

小咪咪 2022-10-25 04:59 176阅读 0赞

## 1：List转数组 ##

### 1.1：工具类 ###

`org.springframework.util.StringUtils`。

### 1.2：使用实例 ###

private List<String> filter(List<String> configurations, AutoConfigurationMetadata autoConfigurationMetadata) { 
    	...
    	String[] candidates = StringUtils.toStringArray(configurations);
    }

## 2：加载`META-INF/spring.factories`数据 ##

`SpringFactoriesLoader.loadFactoryNames({class 全限定名}, {类加载器});`，如：

List<String> configurations = SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(), getBeanClassLoader());

## 3：List去重 ##

protected final <T> List<T> removeDuplicates(List<T> list) { 
    	return new ArrayList<>(new LinkedHashSet<>(list));
    }

## 4：获取classpath是否存在某类 ##

### 4.1：工具类 ###

`org.springframework.util.ClassUtils`。

### 4.2：使用实例 ###

ClassUtils.isPresent("org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration", getClass().getClassLoader())

## 5：逗号分割字符串转换为数组 ##

### 5.1：工具类 ###

`org.springframework.util.StringUtils`。

### 5.2：使用实例 ###

// javax.servlet.Servlet,org.springframework.web.servlet.config.annotation.WebMvcConfigurer,org.springframework.web.servlet.DispatcherServlet
    for (String candidate : StringUtils.commaDelimitedListToStringArray(candidates)) { 
    	ConditionOutcome outcome = getOutcome(candidate, this.beanClassLoader);
    	if (outcome != null) { 
    		return outcome;
    	}
    }

## 6：获取当前使用的类加载器 ##

### 6.1：工具类 ###

`org.springframework.util.ClassUtils`。

### 6.2：使用实例 ###

public static boolean isPresent(String className, ClassLoader classLoader) { 
    	if (classLoader == null) { 
    		classLoader = ClassUtils.getDefaultClassLoader();
    	}
    	try { 
    		forName(className, classLoader);
    		return true;
    	}
    	catch (Throwable ex) { 
    		return false;
    	}
    }

## 7：数组转换为逗号分割字符串 ##

### 7.1：工具类 ###

`org.springframework.util.StringUtils#arrayToDelimitedString`。

### 7.2：使用实例 ###

public Builder andCondition(String condition, Object... details) { 
    	Assert.notNull(condition, "Condition must not be null");
    	String detail = StringUtils.arrayToDelimitedString(details, " ");
    	if (StringUtils.hasLength(detail)) { 
    		return new Builder(condition + " " + detail);
    	}
    	return new Builder(condition);
    }

## 8：数组拷贝 ##

### 8.1：工具类 ###

`java.lang.System#arraycopy`。

### 8.2：使用实例 ###

ConditionOutcome[] secondHalf = secondHalfResolver.resolveOutcomes();
    ConditionOutcome[] firstHalf = firstHalfResolver.resolveOutcomes();
    ConditionOutcome[] outcomes = new ConditionOutcome[autoConfigurationClasses.length];
    System.arraycopy(firstHalf, 0, outcomes, 0, firstHalf.length);
    System.arraycopy(secondHalf, 0, outcomes, split, secondHalf.length);

附源码：

/* src:源数组 srcPos：源数组拷贝的开始位置 dest：目标数组 destPos：拷贝到目标数组的开始位置 length：拷贝源数组的元素的个数 */
    public static native void arraycopy(Object src,  
    									int srcPos,
                                        Object dest, 
                                        int destPos,
                                        int length);

## 9：根据class创建对象 ##

### 9.1：工具类 ###

`org.springframework.beans.BeanUtils#instantiateClass(java.lang.Class<T>)`。

### 9.2：使用实例 ###

protected ConfigurableApplicationContext createApplicationContext() { 
    	Class<?> contextClass = this.applicationContextClass;
    	if (contextClass == null) { 
    		try { 
    			switch (this.webApplicationType) { 
    			case SERVLET:
    				contextClass = Class.forName(DEFAULT_SERVLET_WEB_CONTEXT_CLASS);
    				break;
    			case REACTIVE:
    				contextClass = Class.forName(DEFAULT_REACTIVE_WEB_CONTEXT_CLASS);
    				break;
    			default:
    				contextClass = Class.forName(DEFAULT_CONTEXT_CLASS);
    			}
    		}
    		catch (ClassNotFoundException ex) { 
    			throw new IllegalStateException(
    					"Unable create a default ApplicationContext, " + "please specify an ApplicationContextClass",
    					ex);
    		}
    	}
    	return (ConfigurableApplicationContext) BeanUtils.instantiateClass(contextClass);
    }

## 10：URL转URI ##

### 10.1：工具类 ###

`org.springframework.util.ResourceUtils`。

### 10.2：使用实例 ###

org.springframework.core.io.AbstractResource#getURI
    @Override
    publicURI getURI() throws IOException { 
    	URL url = getURL();
    	try { 
    		return ResourceUtils.toURI(url);
    	}
    	catch (URISyntaxException ex) { 
    		throw new NestedIOException("Invalid URI [" + url + "]", ex);
    	}
    }

## 11：处理路径为标准格式 ##

### 11.1：作用说明 ###

处理相对路径`..`，`.`等信息，如下去除`..`:  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70]  
处理斜杠：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70 1]

### 11.2：工具类 ###

`org.springframework.util.StringUtils#cleanPath`。

### 11.3：使用实例 ###

org.springframework.core.io.FileSystemResource#FileSystemResource(java.lang.String)
    public FileSystemResource(String path) { 
    	Assert.notNull(path, "Path must not be null");
    	this.path = StringUtils.cleanPath(path);
    	this.file = new File(path);
    	this.filePath = this.file.toPath();
    }

## 12：通过`file:`协议文件URL获取File对象 ##

### 12.1：工具类 ###

`org.springframework.util.ResourceUtils#getFile(java.net.URL, java.lang.String)`。

### 12.2：使用实例 ###

org.springframework.core.io.AbstractFileResolvingResource#getFile()
    @Override
    public File getFile() throws IOException { 
    	URL url = getURL();
    	if (url.getProtocol().startsWith(ResourceUtils.URL_PROTOCOL_VFS)) { 
    		return VfsResourceDelegate.getResource(url).getFile();
    	}
    	return ResourceUtils.getFile(url, getDescription());
    }

## 13：判断路径是否包含通配符 ##

### 13.1：工具类 ###

`org.springframework.util.AntPathMatcher#isPattern`。

### 13.1：使用实例 ###

new AntPathMatcher().isPattern("yudaosourcecode/spring/*.class")

## 14：加载.properties文件 ##

### 14.1：工具类 ###

`org.springframework.core.io.support.PropertiesLoaderUtils`。

### 14.2：使用实例 ###

// META-INF/spring.schemas
    Properties mappings = PropertiesLoaderUtils.loadAllProperties(this.schemaMappingsLocation, this.classLoader);
    schemaMappings = new ConcurrentHashMap<>(mappings.size());
    // 合并properties内容到map中
    CollectionUtils.mergePropertiesIntoMap(mappings, schemaMappings);
    this.schemaMappings = schemaMappings;

## 15：合并.properties到map中 ##

### 15.1：工具类 ###

`org.springframework.util.CollectionUtils`。

### 15.2：使用实例 ###

## 16：从一个集合查找在另一个集合中存在的第一个元素 ##

### 16.1：工具类 ###

`org.springframework.util.CollectionUtils#findFirstMatch`。

### 16.2：使用实例 ###

org.springframework.beans.factory.xml.BeanDefinitionParserDelegate#checkNameUniqueness
    protected void checkNameUniqueness(String beanName, List<String> aliases, Element beanElement) { 
    	String foundName = null;
    
    	if (StringUtils.hasText(beanName) && this.usedNames.contains(beanName)) { 
    		foundName = beanName;
    	}
    	if (foundName == null) { 
    		foundName = CollectionUtils.findFirstMatch(this.usedNames, aliases);
    	}
    	if (foundName != null) { 
    		error("Bean name '" + foundName + "' is already used in this <beans> element", beanElement);
    	}
    
    	this.usedNames.add(beanName);
    	this.usedNames.addAll(aliases);
    }

## 17：获取某class的Method对象 ##

### 17.1：工具类 ###

`org.springframework.beans.BeanUtils`，`org.springframework.util.ClassUtils`。

### 17.2：使用实例 ###

org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory#invokeCustomInitMethod
    protected void invokeCustomInitMethod(String beanName, final Object bean, RootBeanDefinition mbd)
    			throws Throwable { 
    
    	String initMethodName = mbd.getInitMethodName();
    	Assert.state(initMethodName != null, "No init method set");
    	Method initMethod = (mbd.isNonPublicAccessAllowed() ?
    			BeanUtils.findMethod(bean.getClass(), initMethodName) :
    			ClassUtils.getMethodIfAvailable(bean.getClass(), initMethodName));
    
    	...snip...
    }

## 18：去除集合中所有元素的空格 ##

### 18.1：工具类 ###

`org.springframework.util.StringUtils`。

### 18.2：使用实例 ###

org.springframework.core.env.AbstractEnvironment#doGetActiveProfiles
    protected Set<String> doGetActiveProfiles() { 
    	synchronized (this.activeProfiles) { 
    		// 为空
    		if (this.activeProfiles.isEmpty()) { 
    			// 从属性源中获取属性名称为ACTIVE_PROFILES_PROPERTY_NAME
    			// 的激活profiles（,分割）
    			String profiles = getProperty(ACTIVE_PROFILES_PROPERTY_NAME);
    			// 如果是在属性源中设置了
    			if (StringUtils.hasText(profiles)) { 
    				// 去除空格，并转换为数组，设置到激活的profiles中
    				// 这里的代码说明，我们只需要设置到环境中如"-Dspring.profiles.active=aa,bb" 
    				// 这里就会自动set了
    				setActiveProfiles(StringUtils.commaDelimitedListToStringArray(
    						StringUtils.trimAllWhitespace(profiles)));
    			}
    		}
    		return this.activeProfiles;
    	}
    }

## 19：将类转换为类名+内存地址字符串 ##

### 19.1：工具类 ###

`org.springframework.util.ObjectUtils`。

### 19.2：使用实例 ###

private String id = ObjectUtils.identityToString(this);

## 20：获取类所在的完整包名 ##

### 20.1：工具类 ###

`org.springframework.util.ClassUtils`。

### 20.2：源码 ###

org.springframework.util.ClassUtils#getPackageName(java.lang.String)
    // 通过给定的全限定类名称获取包名，比如全限定类名称是"java.lang.String"，则包名就是"java.lang",
    // 如果是默认包的话，则返回空字符串
    public static String getPackageName(String fqClassName) { 
    	Assert.notNull(fqClassName, "Class name must not be null");
    	int lastDotIndex = fqClassName.lastIndexOf(PACKAGE_SEPARATOR);
    	return (lastDotIndex != -1 ? fqClassName.substring(0, lastDotIndex) : "");
    }

## 21：转换json字符串为map ##

### 21.1：工具类 ###

`org.springframework.boot.json.JsonParser`。

### 21.2：源码 ###

org.springframework.boot.env.SpringApplicationJsonEnvironmentPostProcessor#processJson
    private void processJson(ConfigurableEnvironment environment, JsonPropertyValue propertyValue) { 
    	JsonParser parser = JsonParserFactory.getJsonParser();
    	Map<String, Object> map = parser.parseMap(propertyValue.getJson());
    	if (!map.isEmpty()) { 
    		addJsonPropertySource(environment, new JsonPropertySource(propertyValue, flatten(map)));
    	}
    }

## 22：获取文件扩展名 ##

### 22.1：工具类 ###

`org.springframework.util.StringUtils#getFilenameExtension`。

### 22.2：实例 ###

org.springframework.boot.logging.AbstractLoggingSystem#getSpringConfigLocations
    protected String[] getSpringConfigLocations() { 
    	String[] locations = getStandardConfigLocations();
    	for (int i = 0; i < locations.length; i++) { 
    		String extension = StringUtils.getFilenameExtension(locations[i]);
    		locations[i] = locations[i].substring(0, locations[i].length() - extension.length() - 1) + "-spring."
    				+ extension;
    	}
    	return locations;
    }

## 23：通过class获取指定类型的注解对象 ##

### 23.1：工具类 ###

`org.springframework.core.annotation.AnnotationUtils#findAnnotation(java.lang.Class<?>, java.lang.Class<A>)`。

### 23.2：实例 ###

org.springframework.boot.context.properties.EnableConfigurationPropertiesImportSelector.ConfigurationPropertiesBeanRegistrar#getName
    private String getName(Class<?> type) { 
    	ConfigurationProperties annotation = AnnotationUtils.findAnnotation(type, ConfigurationProperties.class);
    	String prefix = (annotation != null) ? annotation.prefix() : "";
    	return (StringUtils.hasText(prefix) ? prefix + "-" + type.getName() : type.getName());
    }

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70]: /images/20221024/ac31b54fc73a4c98988aec4ef4f681ad.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70 1]: /images/20221024/eaf3c728780e44888de7ebad7b7137f9.png