快捷導(dǎo)航

Java?SpringBoot?獲取接口實現(xiàn)類匯總

更新時間：2022年09月01日 15:37:12 作者：Charge8

這篇文章主要介紹了Java?SpringBoot?獲取接口實現(xiàn)類匯總，文章圍繞主題展開詳細(xì)的內(nèi)容介紹，具有一定的參考價值，需要的小伙伴可以參考一下

前言

有時候，根據(jù)業(yè)務(wù)邏輯的需求，需要獲取到某個接口的所有實現(xiàn)類，然后根據(jù)業(yè)務(wù)類型來執(zhí)行不同的實現(xiàn)類方法。有點類似策略模式。

如果沒有用到 Spring的話，可以使用 ServiceLoaderl類JDK自帶的一個類加載器（其他框架的SPI機制也是可以實現(xiàn)）。

ServiceLoader<MyInterface> loader = ServiceLoader.load(接口名.class);

如果接口的所有實現(xiàn)類均被 Spring托管了。那么我們可以從Spring的IOC容器中可以很簡單的獲取這些實現(xiàn)類。

以上兩種方式，實現(xiàn)的功能都是一樣的，實現(xiàn)方式不同，底層用的技術(shù)一樣的，都是反射。

下面我們基于 Spring管理的 bean中來獲取接口的所有實現(xiàn)類。

可以直接使用 Spring的 @Autowired注解。也可以使用 ApplicationContextAware接口來獲取并管理所有實現(xiàn)類。

一、獲取接口的所有實現(xiàn)類

1、枚舉

這個枚舉根據(jù)業(yè)務(wù)自行創(chuàng)建，可有可無。

public enum XxxTypeEnum {
    XXX_1("code1", "xxx1業(yè)務(wù)"),
    XXX_2("code2", "xxx2業(yè)務(wù)"),
    ;
    private String code;
    private String desc;
    XxxTypeEnum(String code, String desc) {
        this.code = code;
        this.desc = desc;
    }
    public String getCode() {
        return code;
    }
    public void setCode(String code) {
        this.code = code;
    }
    public String getDesc() {
        return desc;
    }
    public void setDesc(String desc) {
        this.desc = desc;
    }

}

2、業(yè)務(wù)接口

public interface IXxxService {

    /**
     *是否支持
     * @param xxxTypeEnum
     * @return
     */
    boolean isSupport(XxxTypeEnum xxxTypeEnum);

    /**
     * 拼接字符串業(yè)務(wù)方法
     *
     * @param a
     * @param b
     * @return
     */
    String spliceStr(String a, String b);
}

2.1 實現(xiàn)類

1）Xxx001ServiceImpl

@Service
public class Xxx001ServiceImpl implements IXxxService {
    @Override
    public boolean isSupport(XxxTypeEnum xxxTypeEnum) {
        return XxxTypeEnum.XXX_1.equals(xxxTypeEnum);
    }
    @Override
    public String spliceStr(String a, String b) {
        return a + "--Xxx001ServiceImpl--" + "b";
    }
}

2）Xxx002ServiceImpl

@Service
public class Xxx002ServiceImpl implements IXxxService {
    @Override
    public boolean isSupport(XxxTypeEnum xxxTypeEnum) {
        return XxxTypeEnum.XXX_2.equals(xxxTypeEnum);
    }
    @Override
    public String spliceStr(String a, String b) {
        return a + "--Xxx002ServiceImpl--" + "b";
    }

}

3、ApplicationContextAware接口實現(xiàn)類

獲取到所有實現(xiàn)類，然后根據(jù)業(yè)務(wù)管理所有實現(xiàn)類。

@Component
public class XxxServiceLocator implements ApplicationContextAware {
	/**
	 * 存儲 IXxxService接口的所有實現(xiàn)類
	 */
	private Map<String, IXxxService> xxxServiceMap;
	private List<IXxxService> xxxServiceList;
	@Override
	public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
		// 通過上下文，根據(jù)接口類型返回相應(yīng)的所有實現(xiàn)類bean
		xxxServiceMap = applicationContext.getBeansOfType(IXxxService.class);
		xxxServiceList = new ArrayList<>(xxxServiceMap.values());
	}
	/**
	 * 獲取所有實現(xiàn)類
	 *
	 * @return
	 */
	public Map<String, IXxxService> getAllMap() {
		return xxxServiceMap;
	}

	/**
	 * 通過名稱獲取某個實現(xiàn)類
	 *
	 * @param beanName
	 *            bean名字
	 * @return
	 */
	private IXxxService getByName(String beanName) {
		return xxxServiceMap.get(beanName);
	}

	/**
	 * 獲取所有實現(xiàn)類
	 *
	 * @return
	 */
	public List<IXxxService> getAllList() {
		return xxxServiceList;
	}

	/**
	 * 根據(jù)枚舉獲取某個實現(xiàn)類
	 *
	 * @param xxxTypeEnum
	 * @return
	 */
	public IXxxService get(XxxTypeEnum xxxTypeEnum) {
		IXxxService xxxService = xxxServiceList.stream().filter(s -> s.isSupport(xxxTypeEnum))
				.collect(Collectors.toList()).get(0);
		return xxxService;
	}

}

4、獲取到所有實現(xiàn)類使用

@RestController
@RequestMapping(value = "/xxx")
public class XxxController {
    /**
     * 方式1：直接使用spring依賴注入注解
     */
    @Autowired
    private Map<String, IXxxService> xxxServiceMap;

    /**
     * 方式2：直接使用spring的依賴注入注解
     */
    @Autowired
    private List<IXxxService> xxxServiceList;

    /**
     * 方式3：借助spring的ApplicationContextAware
     */
    @Autowired
    private XxxServiceLocator xxxServiceLocator;

    /**
     * 獲取到所有實現(xiàn)類使用
     *
     */
    @RequestMapping(value = "/getAll", method = RequestMethod.GET)
    public void getAll() {
        String a = "asasa";
        String b = "bnbnb";
        Map<String, IXxxService> allMap = xxxServiceLocator.getAllMap();
        List<IXxxService> allList = xxxServiceLocator.getAllList();

        System.out.println("allMap              --->" + allMap);
        System.out.println("xxxServiceMap       --->" + xxxServiceMap);
        System.out.println("allList             --->" + allList);
        System.out.println("xxxServiceList      --->" + xxxServiceList);
        for (IXxxService iXxxService : xxxServiceList) {
            System.out.println("xxxServiceList執(zhí)行結(jié)果  ---> " + iXxxService.spliceStr(a, b));
        }
        IXxxService iXxxService = xxxServiceLocator.get(XxxTypeEnum.XXX_1);
        System.out.println("XxxEnum.XXX_1執(zhí)行結(jié)果  ---> " + iXxxService.spliceStr(a, b));
        iXxxService = xxxServiceLocator.get(XxxTypeEnum.XXX_2);
        System.out.println("XxxEnum.XXX_2執(zhí)行結(jié)果  ---> " + iXxxService.spliceStr(a, b));

    }
}