關(guān)于Controller請求方法：private和public的區(qū)別

最近，在公司 CodeReview 會上，我給眾多同事布置了“家庭作業(yè)”。Controller 中的請求方法，通常我們都是 public 的，如果是 private 的、protected 的行不行，為什么？

后來一個同事比較認(rèn)真，第二天早上測試后發(fā)現(xiàn)報錯了，給我反饋說 private 方法的內(nèi)部注入的 service 為 null，修改成 public 后就不會為 null。為什么會產(chǎn)生這個問題呢?這個同事沒有回答出來，今天我抽空調(diào)試了一下源碼，給大家總結(jié)一下，分享給大家！

首先簡單模擬一下環(huán)境

public?interface?TestService?{
????String?getTestString();
}

@Service("testService")
public?class?TestServiceImpl?implements?TestService?{
????@Override
????public?String?getTestString()?{
????????return?"業(yè)余草";
????}
}
????
@RestController
public?class?MainController?{
????@Autowired
????private?TestService?service;

????@RequestMapping("/testA")
????public?String?testA(){
????????return?service.getTestString();
????}
????@RequestMapping("/testB")
????private?String?testB(){
????????return?service.getTestString();
????}

}

/testA是 pulibc，/testB是 pirvate，測試結(jié)果「均能返回"業(yè)余草"字符串」

測試和公司環(huán)境還有一個不太同的就是公司項(xiàng)目中有 Aop 切面處理訪問日志的，還要添加一個 Aop。

@Aspect
@Component
public?class?WebLogAspect?{
????private?final?Logger?logger?=?LoggerFactory.getLogger(WebLogAspect.class);

????@Pointcut("execution(public?*?com.spring.controller..*.*(..))")
????public?void?controllerLog(){}

????@Before("controllerLog()")
????public?void?logBeforeController(JoinPoint?joinPoint)?{
????????RequestAttributes?requestAttributes?=?RequestContextHolder.getRequestAttributes();
????????HttpServletRequest?request?=?((ServletRequestAttributes)requestAttributes).getRequest();
????????logger.info("*************URL?:?"?+?request.getRequestURL().toString());
????????logger.info("*************HTTP_METHOD?:?"?+?request.getMethod());
????????logger.info("*************IP?:?"?+?request.getRemoteAddr());
????}????
}

添加了一個 Aop 后測試：

/testA返回"業(yè)余草"字符串??
/testB訪問報錯，service注入失敗，為null

為什么使用 Aop 會導(dǎo)致 private 修飾的方法注入失敗，查詢了許多資料，網(wǎng)上有人說到 org.springframework.aop.support.AopUtils中的代碼使用的是Method[] methods = clazz.getMethods()，即是只能拿到 public 方法。但是我使用的版本2.1.4.RELEASE中已經(jīng)使用Method[] methods = ReflectionUtils.getAllDeclaredMethods(clazz);這就有點(diǎn)迷惑了。

會不會是切點(diǎn)注解中的修飾符匹配不到呢？將切點(diǎn)中的修飾符從 public 修改成 private。

@Pointcut("execution(private*?com.spring.controller..*.*(..))")
??public?void?controllerLog(){}

測試結(jié)果：

/testA返回"業(yè)余草"字符串??
/testB訪問報錯，service注入失敗，為null

還是不行（就挺禿然的）。

哎，想偷懶還不行，只能我一行一行調(diào)試代碼了。

基于 Spring Boot + MyBatis Plus + Vue & Element 實(shí)現(xiàn)的后臺管理系統(tǒng) + 用戶小程序，支持 RBAC 動態(tài)權(quán)限、多租戶、數(shù)據(jù)權(quán)限、工作流、三方登錄、支付、短信、商城等功能

項(xiàng)目地址：https://gitee.com/zhijiantianya/ruoyi-vue-pro

視頻教程：https://doc.iocoder.cn/video/

目前結(jié)論

方法中沒有用@Autowired或者@Resource注入的對象。有無 Aop，任意修飾符都可以正常訪問并且返回結(jié)果

方法中使用了@Autowired或者@Resource注入的對象沒有 Aop 切面的情況下，public，protected，private都能正常的映射在有 Aop 切面的情況下，public，protected可以正常映射，但是使用private會報空指針異常，注入對象為 null。

最后經(jīng)過我的一番折騰與調(diào)試之后，發(fā)現(xiàn)：

使用了 aop，也就是使用動態(tài)代理，你的 SpringBoot 版本為 2.1.4 release，底層默認(rèn)調(diào)用的是 cglib 作為動態(tài)代理。

其本質(zhì)是：調(diào)用某個類的方法時，實(shí)際上是先為該類生成一個子類，然后再在子類中通過反射等，達(dá)到方法攔截的目的。對于子類，其父類中，private修飾的方法，子類如果與父類不在同一包下，是沒有訪問的權(quán)限的，此場景下，cglib 生成的子類，不會和父類在同一包下，也就是private修飾的方法，不能進(jìn)行動態(tài)代理，所以會報空指針異常。

編輯：黃飛