Spring中提供的扩展点之ApplicationContextAware接口的在项目中的使用

前言：在springBoot项目中，我们平常的工具类一般都是基于jdk层面来写的，但是如果我们想写一个基于web层面的工具类呢？各种属性都是在容器里，request…里面，难不成这个web层面的工具类也是靠注入各种bean来实现的嘛？显然不是的，这样的代码太多就不是工具类咯，而此时ApplicationContextAware的作用就体现出来啦

ApplicationContextAware 概括

Spring容器会自动把上下文环境对象通过调用ApplicationContextAware接口中的setApplicationContext方法注入进来，而我们要做的就是实现ApplicationContextAware接口，把ApplicationContext 注入到我们自己的工具类中就好了。

项目实战

工具类中有了ApplicationContext就拥有了获取各种bean、request、通过request还可以写很多工具方法…这个工具类就可以干很多事情了。

/**
 * @author zzh
 * @class
 */
@Component
public class webUtil implements ApplicationContextAware, DisposableBean {
    private static ApplicationContext applicationContext;

    public static final String COMPUTER = "C"; //"Computer"
    public static final String MOBILE = "M"; //"Mobile"
    public static final String UNKNOWN = "Unknown";
    public static final String USER_AGENT = "User-Agent";

    /**
     * 根据名字获取bean集合
     */
    public Object getBean(String name) {
        return applicationContext.getBean(name);
    }

    /**
     * 取得实际路径
     */
    public static String getRealPath(String path) {
        return getCurrentRequest().getServletContext().getRealPath(path);
    }

    /**
     * 根据类型获取bean
     */
    public <T> Map<String, T> getBeansOfType(Class<T> tClass) {
        return applicationContext.getBeansOfType(tClass);
    }

    /**
     * 获取当前request对象
     */
    public static HttpServletRequest getCurrentRequest() {
        ServletRequestAttributes requestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest currentRequest = requestAttributes.getRequest();
        return currentRequest;
    }

    /**
     * 获得设备类型
     */
    public static String getDeviceType(String userAgentHeader) {
        if (userAgentHeader == null) return COMPUTER;
        if (userAgentHeader.contains("Andriod") || userAgentHeader.contains("iPhone") || userAgentHeader.contains("iPad"))
            return MOBILE;
        return COMPUTER;
    }

    /**
     * 取得设备类型
     */
    public static String getDeviceType() {
        String userAgent = getCurrentRequest().getHeader(USER_AGENT);
        return getDeviceType(userAgent);
    }

    /**
     * 当前是否是电脑设备
     */
    public static boolean isComputer() {
        return COMPUTER.equals(getDeviceType());
    }

    /**
     * 从IOC中获得对象: 根据类型
     */
    public static <T> T getBean(Class<T> requiredType) {
        return applicationContext.getBean(requiredType);
    }

    /**
     * 根据Request获取IP地址
     * <p>
     * 使用Nginx等反向代理软件， 则不能通过request.getRemoteAddr()获取IP地址
     * 如果使用了多级反向代理的话，X-Forwarded-For的值并不止一个，
     * 而是一串IP地址，X-Forwarded-For中第一个非unknown的有效IP字符串，则为真实IP地址
     */
    public static String getIpAddr(HttpServletRequest request) {
        // 代理处理
        String ip = request.getHeader("x-forwarded-for");
        if (blankOrUnknown(ip)) ip = request.getHeader("Proxy-Client-IP");
        if (blankOrUnknown(ip)) ip = request.getHeader("WL-Proxy-Client-IP");
        if (blankOrUnknown(ip)) ip = request.getHeader("HTTP_CLIENT_IP");
        if (blankOrUnknown(ip)) ip = request.getHeader("HTTP_X_FORWARDED_FOR");
        // 多级代理
        if (StringUtils.isNotBlank(ip) && ip.contains(",")) ip = ip.split(",")[0];
        // 正常处理
        if (blankOrUnknown(ip)) ip = request.getRemoteAddr();
        // 特殊设置
        if ("0:0:0:0:0:0:0:1".equals(ip) || "localhost".equals(ip)) ip = "127.0.0.1";
        //非空限定
        if (ip == null) ip = "unknown";
        return ip;
    }

    //IP地址为空(白)或为unknown
    private static boolean blankOrUnknown(String ip) {
        return StringUtils.isBlank(ip) || "unknown".equalsIgnoreCase(ip);
    }

    /**
     * 是否为ajax请求
     */
    public static boolean isAjax(HttpServletRequest request) {
        //如果是ajax请求响应头会有，x-requested-with
        if (request.getHeader("x-requested-with") != null
                && request.getHeader("x-requested-with").equalsIgnoreCase("XMLHttpRequest")) {
            return true;
        }
        return false;
    }

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        webUtil.applicationContext = applicationContext;
    }

    @Override
    public void destroy() throws Exception {
        webUtil.applicationContext = null;
    }
}

项目中使用

随便在一个service中使用就行了

@Service
@Slf4j
public class GoodsServiceImpl extends ServiceImpl<GoodsMapper, Goods> implements GoodsService {
    public void testWebUtil() {
        log.info("设备类型: "+webUtil.getDeviceType());
        log.info("获取GoodsServiceImpl bean: "+webUtil.getBean(GoodsServiceImpl.class));
        log.info("是否是ajax请求: "+webUtil.isAjax(webUtil.getCurrentRequest()));
        log.info("当前请求的ip: "+webUtil.getIpAddr(webUtil.getCurrentRequest()));
    }
}

springBoot单元测试

@SpringBootTest
@RunWith(SpringRunner.class)
class MybatisplusDaynamicAnnotationSqlApplicationTests {
    @Test
    void testWebUtil() {
        goodsService.testWebUtil();
    }
}

测试结果

完整测试代码点这，如果觉着对你有帮助的话，可以start一下哦