cacheable注解原理_Java注解@Cacheable的工作原理

In order to avoid unnecessary query on database it is a common pattern to define a cache in application layer to cache the query result from database. See one example below. Here the application cache is maintained in a custom class CacheContext.public class AccountService1 {

private final Logger logger = LoggerFactory.getLogger(AccountService1.class);

private CacheContext accountCacheContext;

public Account getAccountByName(String accountName) {

Account result = accountCacheContext.get(accountName);

if (result != null) {

logger.info("get from cache... {}", accountName);

return result;

}

Optional accountOptional = getFromDB(accountName);

if (!accountOptional.isPresent()) {

throw new IllegalStateException(String.format("can not find account by account name : [%s]", accountName));

}

Account account = accountOptional.get();

accountCacheContext.addOrUpdateCache(accountName, account);

return account;

}

In Spring there is an annotation @Cacheable which can make the cache managed by Spring instead of application developer. See improved version:public class AccountService2 {

private final Logger logger = LoggerFactory.getLogger(AccountService2.class);

@Cacheable(value="accountCache")

public Account getAccountByName(String accountName) {

logger.info("in method getAccountByName, querying account... {}", accountName);

Optional accountOptional = getFromDB(accountName);

if (!accountOptional.isPresent()) {

throw new IllegalStateException(String.format("can not find account by account name : [%s]", accountName));

}

return accountOptional.get();

}

In this example, there is no more cache evaluation and cache fill logic. All such stuff are taken over by Spring under the hood and completely transparent to application developer, with the help of following bean configuration in xml:

class="org.springframework.cache.concurrent.ConcurrentMapCacheFactoryBean">

class="org.springframework.cache.concurrent.ConcurrentMapCacheFactoryBean">

And how to research what magic has been done by Spring to achieve this behavior?

We use the following code to research. It is expected that the request sent by line 31 will directly reach database, while the second request in line 34 will be handled by Spring cache handler.

cacheable注解原理_Java注解@Cacheable的工作原理_第1张图片

Here in line 31, in debugger we can find that accountService2 is not an instance of application class com.sap.AccountService2, but a dynamic proxy class generated by Spring.

cacheable注解原理_Java注解@Cacheable的工作原理_第2张图片

As a result after pressing F5, the intercept method of this dynamic proxy class is called:

cacheable注解原理_Java注解@Cacheable的工作原理_第3张图片

In this method, the execution will be delegated to Spring cache handler class:

cacheable注解原理_Java注解@Cacheable的工作原理_第4张图片

cacheable注解原理_Java注解@Cacheable的工作原理_第5张图片

In example 1, the logic of cache evaluation and fill is done by application, and now it is done in method execute below.

cacheable注解原理_Java注解@Cacheable的工作原理_第6张图片

First internal cache managed by Spring is checked in line 336 via method findCachedItem. Due to expected cache miss, our application method will be called as usual via reflection, as demonstrated below:

cacheable注解原理_Java注解@Cacheable的工作原理_第7张图片

After application method to retrieve account from database is done, the result, Account instance with id 2495 is filled to Spring cache, the variable contexts below.

cacheable注解原理_Java注解@Cacheable的工作原理_第8张图片

Below is the screenshot for Spring internal cache to store application data, which is based on ConcurrentHashMap. Our cached Account instance with id 2495 could be found there.

cacheable注解原理_Java注解@Cacheable的工作原理_第9张图片

cacheable注解原理_Java注解@Cacheable的工作原理_第10张图片

For the second query request issued by application, the cached result will be returned by Spring handler:

cacheable注解原理_Java注解@Cacheable的工作原理_第11张图片

The last question is, how and when the dynamic proxy is generated?

Again let’s go to the entry point of Beans initialization:

cacheable注解原理_Java注解@Cacheable的工作原理_第12张图片

cacheable注解原理_Java注解@Cacheable的工作原理_第13张图片

Here the dynamic proxy is created based on configuration defined in xml with the help of CGlibAopProxy. For more detail about CGlibAopProxy, please refer to Spring official document.

要获取更多Jerry的原创文章,请关注公众号"汪子熙":

cacheable注解原理_Java注解@Cacheable的工作原理_第14张图片

你可能感兴趣的:(cacheable注解原理)