8. IOUtils
IO流在我们日常工作中也用得比较多,尽管java已经给我们提供了丰富的API。
但我们不得不每次读取文件,或者写入文件之后,写一些重复的的代码。手动在finally代码块中关闭流,不然可能会造成内存溢出。
有个好消息是:如果你使用org.apache.commons.io包下的IOUtils类,会节省大量的时间。
8.1 读取文件
如果你想将某个txt文件中的数据,读取到字符串当中,可以使用IOUtils类的toString方法。例如:
String str = IOUtils.toString(new FileInputStream("/temp/a.txt"), StandardCharsets.UTF_8);
System.out.println(str);
8.2 写入文件
如果你想将某个字符串的内容,写入到指定文件当中,可以使用IOUtils类的write方法。例如:
String str = "abcde";
IOUtils.write(str, new FileOutputStream("/temp/b.tx"), StandardCharsets.UTF_8);
8.3 文件拷贝
如果你想将某个文件中的所有内容,都拷贝到另一个文件当中,可以使用IOUtils类的copy方法。例如:
IOUtils.copy(new FileInputStream("/temp/a.txt"), new FileOutputStream("/temp/b.txt"));
8.4 读取文件内容到字节数组
如果你想将某个文件中的内容,读取字节数组中,可以使用IOUtils类的toByteArray方法。例如:
byte[] bytes = IOUtils.toByteArray(new FileInputStream("/temp/a.txt"));
IOUtils类非常实用,感兴趣的小伙们,可以看看下面内容。
9. MDC
MDC是org.slf4j包下的一个类,它的全称是Mapped Diagnostic Context,我们可以认为它是一个线程安全的存放诊断日志的容器。
MDC的底层是用了ThreadLocal来保存数据的。
我们可以用它传递参数。
例如现在有这样一种场景:我们使用RestTemplate调用远程接口时,有时需要在header中传递信息,比如:traceId,source等,便于在查询日志时能够串联一次完整的请求链路,快速定位问题。
这种业务场景就能通过ClientHttpRequestInterceptor接口实现,具体做法如下:
第一步,定义一个LogFilter拦截所有接口请求,在MDC中设置traceId:
public class LogFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
MdcUtil.add(UUID.randomUUID().toString());
System.out.println("记录请求日志");
chain.doFilter(request, response);
System.out.println("记录响应日志");
}
@Override
public void destroy() {
}
}
第二步,实现ClientHttpRequestInterceptor接口,MDC中获取当前请求的traceId,然后设置到header中:
public class RestTemplateInterceptor implements ClientHttpRequestInterceptor {
@Override
public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {
request.getHeaders().set("traceId", MdcUtil.get());
return execution.execute(request, body);
}
}
第三步,定义配置类,配置上面定义的RestTemplateInterceptor类:
@Configuration
public class RestTemplateConfiguration {
@Bean
public RestTemplate restTemplate() {
RestTemplate restTemplate = new RestTemplate();
restTemplate.setInterceptors(Collections.singletonList(restTemplateInterceptor()));
return restTemplate;
}
@Bean
public RestTemplateInterceptor restTemplateInterceptor() {
return new RestTemplateInterceptor();
}
}
其中MdcUtil其实是利用MDC工具在ThreadLocal中存储和获取traceId
public class MdcUtil {
private static final String TRACE_ID = "TRACE_ID";
public static String get() {
return MDC.get(TRACE_ID);
}
public static void add(String value) {
MDC.put(TRACE_ID, value);
}
}
当然,这个例子中没有演示MdcUtil类的add方法具体调的地方,我们可以在filter中执行接口方法之前,生成traceId,调用MdcUtil类的add方法添加到MDC中,然后在同一个请求的其他地方就能通过MdcUtil类的get方法获取到该traceId。
能使用MDC保存traceId等参数的根本原因是,用户请求到应用服务器,Tomcat会从线程池中分配一个线程去处理该请求。
那么该请求的整个过程中,保存到MDC的ThreadLocal中的参数,也是该线程独享的,所以不会有线程安全问题。
10. ClassUtils
spring的org.springframework.util包下的ClassUtils类,它里面有很多让我们惊喜的功能。
它里面包含了类和对象相关的很多非常实用的方法。
10.1 获取对象的所有接口
如果你想获取某个对象的所有接口,可以使用ClassUtils的getAllInterfaces方法。例如:
Class<?>[] allInterfaces = ClassUtils.getAllInterfaces(new User());
10.2 获取某个类的包名
如果你想获取某个类的包名,可以使用ClassUtils的getPackageName方法。例如:
String packageName = ClassUtils.getPackageName(User.class);
System.out.println(packageName);
10.3 判断某个类是否内部类
如果你想判断某个类是否内部类,可以使用ClassUtils的isInnerClass方法。例如:
System.out.println(ClassUtils.isInnerClass(User.class));
10.4 判断对象是否代理对象
如果你想判断对象是否代理对象,可以使用ClassUtils的isCglibProxy方法。例如:
System.out.println(ClassUtils.isCglibProxy(new User()));
ClassUtils还有很多有用的方法,等待着你去发掘。感兴趣的朋友,可以看看下面内容:
11. BeanUtils
spring给我们提供了一个JavaBean的工具类,它在org.springframework.beans包下面,它的名字叫做:BeanUtils。
让我们一起看看这个工具可以带给我们哪些惊喜。
11.1 拷贝对象的属性
曾几何时,你有没有这样的需求:把某个对象中的所有属性,都拷贝到另外一个对象中。这时就能使用BeanUtils的copyProperties方法。例如:
User user1 = new User();
user1.setId(1L);
user1.setName("苏三说技术");
user1.setAddress("成都");
User user2 = new User();
BeanUtils.copyProperties(user1, user2);
System.out.println(user2);
11.2 实例化某个类
如果你想通过反射实例化一个类的对象,可以使用BeanUtils的instantiateClass方法。例如:
User user = BeanUtils.instantiateClass(User.class);
System.out.println(user);
11.3 获取指定类的指定方法
如果你想获取某个类的指定方法,可以使用BeanUtils的findDeclaredMethod方法。例如:
Method declaredMethod = BeanUtils.findDeclaredMethod(User.class, "getId");
System.out.println(declaredMethod.getName());
11.4 获取指定方法的参数
如果你想获取某个方法的参数,可以使用BeanUtils的findPropertyForMethod方法。例如:
Method declaredMethod = BeanUtils.findDeclaredMethod(User.class, "getId");
PropertyDescriptor propertyForMethod = BeanUtils.findPropertyForMethod(declaredMethod);
System.out.println(propertyForMethod.getName());
如果你对BeanUtils比较感兴趣,可以看看下面内容:
12. ReflectionUtils
有时候,我们需要在项目中使用反射功能,如果使用最原始的方法来开发,代码量会非常多,而且很麻烦,它需要处理一大堆异常以及访问权限等问题。
好消息是spring给我们提供了一个ReflectionUtils工具,它在org.springframework.util包下面。
12.1 获取方法
如果你想获取某个类的某个方法,可以使用ReflectionUtils类的findMethod方法。例如:
Method method = ReflectionUtils.findMethod(User.class, "getId");
12.2 获取字段
如果你想获取某个类的某个字段,可以使用ReflectionUtils类的findField方法。例如:
Field field = ReflectionUtils.findField(User.class, "id");
12.3 执行方法
如果你想通过反射调用某个方法,传递参数,可以使用ReflectionUtils类的invokeMethod方法。例如:
ReflectionUtils.invokeMethod(method, springContextsUtil.getBean(beanName), param);
12.4 判断字段是否常量
如果你想判断某个字段是否常量,可以使用ReflectionUtils类的isPublicStaticFinal方法。例如:
Field field = ReflectionUtils.findField(User.class, "id");
System.out.println(ReflectionUtils.isPublicStaticFinal(field));
12.5 判断是否equals方法
如果你想判断某个方法是否equals方法,可以使用ReflectionUtils类的isEqualsMethod方法。例如:
Method method = ReflectionUtils.findMethod(User.class, "getId");
System.out.println(ReflectionUtils.isEqualsMethod(method));
当然这个类还有不少有趣的方法,感兴趣的朋友,可以看看下面内容:
13. Base64Utils
有时候,为了安全考虑,需要将参数只用base64编码。
这时就能直接使用org.springframework.util包下的Base64Utils工具类。
它里面包含:encode和decode方法,用于对数据进行加密和解密。例如:
String str = "abc";
String encode = new String(Base64Utils.encode(str.getBytes()));
System.out.println("加密后:" + encode);
try {
String decode = new String(Base64Utils.decode(encode.getBytes()), "utf8");
System.out.println("解密后:" + decode);
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
执行结果:
加密后:YWJj
解密后:abc
14. StandardCharsets
我们在做字符转换的时候,经常需要指定字符编码,比如:UTF-8、ISO-8859-1等等。
这时就可以直接使用java.nio.charset包下的StandardCharsets类中静态变量。
例如:
String str = "abc";
String encode = new String(Base64Utils.encode(str.getBytes()));
System.out.println("加密后:" + encode);
String decode = new String(Base64Utils.decode(encode.getBytes())
, StandardCharsets.UTF_8);
System.out.println("解密后:" + decode);
15. DigestUtils
有时候,我们需要对数据进行加密处理,比如:md5或sha256。
可以使用apache的org.apache.commons.codec.digest包下的DigestUtils类。
15.1 md5加密
如果你想对数据进行md5加密,可以使用DigestUtils的md5Hex方法。例如:
String md5Hex = DigestUtils.md5Hex("苏三说技术");
System.out.println(md5Hex);
15.2 sha256加密
如果你想对数据进行sha256加密,可以使用DigestUtils的sha256Hex方法。例如:
String md5Hex = DigestUtils.sha256Hex("苏三说技术");
System.out.println(md5Hex);
当然这个工具还有很多其他的加密方法:
16. SerializationUtils
有时候,我们需要把数据进行序列化和反序列化处理。
传统的做法是某个类实现Serializable接口,然后重新它的writeObject和readObject方法。
但如果使用org.springframework.util包下的SerializationUtils工具类,能更轻松实现序列化和反序列化功能。例如:
Map<String, String> map = Maps.newHashMap();
map.put("a", "1");
map.put("b", "2");
map.put("c", "3");
byte[] serialize = SerializationUtils.serialize(map);
Object deserialize = SerializationUtils.deserialize(serialize);
System.out.println(deserialize);
17. HttpStatus
很多时候,我们会在代码中定义http的返回码,比如:接口正常返回200,异常返回500,接口找不到返回404,接口不可用返回502等。
private int SUCCESS_CODE = 200;
private int ERROR_CODE = 500;
private int NOT_FOUND_CODE = 404;
其实org.springframework.http包下的HttpStatus枚举,或者org.apache.http包下的HttpStatus接口,已经把常用的http返回码给我们定义好了,直接拿来用就可以了,真的不用再重复定义了。