\n@Before("pointcut()")\npublic void beforeMethod(JoinPoint joinPoint)\n{\n\/\/...\n}\n<\/pre><\/div>\n\n\nAfter advice<\/strong> \u2013 porada, kt\u00f3ra zostanie zrealizowana po wykonaniu metod punktu \u0142\u0105czenia. Nale\u017cy zwr\u00f3ci\u0107 uwag\u0119, i\u017c ten typ porady wykona si\u0119 niezale\u017cnie od wyniku metody (zar\u00f3wno w przypadku pomy\u015blnego wywo\u0142ania jak i w przypadku wyst\u0105pienia wyj\u0105tku). Jej dzia\u0142anie mo\u017cna por\u00f3wna\u0107 do bloku finally. Adnotacja, jak\u0105 nale\u017cy j\u0105 oznaczy\u0107, to @After<\/strong>. Porada ta jako parametr mo\u017ce przyjmowa\u0107 obiekt typu JoinPoint.<\/p>\n\n\n\n@After("pointcut()")\npublic void afterMethod(JoinPoint joinPoint)\n{\n\/\/...\n}\n<\/pre><\/div>\n\n\nAfter returning<\/strong> \u2013 w przeciwie\u0144stwie do porad typu @After mo\u017cemy u\u017cy\u0107 porady, kt\u00f3ra wykonana zostanie tylko w przypadku pomy\u015blnego wywo\u0142ania metody. Tak\u0105 porad\u0119 nale\u017cy oznaczy\u0107 adnotacj\u0105 @AfterReturning<\/strong>. Jako parametr mo\u017ce przyjmowa\u0107 ona obiekt typu JoinPoint oraz obiekt zwracanej przez funkcj\u0119 warto\u015bci (powi\u0105zanie nast\u0119puje za pomoc\u0105 parametru returning adnotacji).<\/p>\n\n\n\n@AfterReturning(pointcut = "pointcut()", returning = "response")\npublic void afterReturningMethod(JoinPoint joinPoint, ResponseEntity<?> response)\n{\n\/\/...\n}\n<\/pre><\/div>\n\n\nAfter throwing<\/strong> \u2013 uzupe\u0142nienie stanowi porada, kt\u00f3ra wykona si\u0119 tylko w przypadku, gdy metoda punktu \u0142\u0105czenia zg\u0142osi wyj\u0105tek. Tego typu porady nale\u017cy odznaczy\u0107 adnotacj\u0105 @AfterThrowing<\/strong>. Jako parametr mo\u017ce ona przyjmowa\u0107 obiektu typu JoinPoint oraz obiekt zg\u0142aszanego wyj\u0105tku (powi\u0105zany za pomoc\u0105 atrybutu throwing adnotacji). <\/p>\n\n\n\n@AfterThrowing(pointcut = "pointcut()", throwing = "ex")\npublic void afterThrowingMethod(JoinPoint joinPoint, Exception ex) {\n\/\/...\n}\n<\/pre><\/div>\n\n\nAround<\/strong> \u2013 porada, kt\u00f3ra pozwala nam na otoczenie wywo\u0142ania metody punktu przeci\u0119cia oraz dodanie logiki zar\u00f3wno przed jej wykonaniem jak i po. Dodatkowo, sami jeste\u015bmy odpowiedzialni za jej wykonanie i dzi\u0119ki niej mamy mo\u017cliwo\u015b\u0107 pomini\u0119cia wykonania takiej metody. Do tworzenia tego typu porady wykorzystywana jest adnotacja @Around<\/strong>.<\/p>\n\n\n\nW przeciwie\u0144stwie do poprzednich typ\u00f3w, porada ta przyjmuje obiekt typu ProceedingJoinPoint, na kt\u00f3rym mamy mo\u017cliwo\u015b\u0107 wywo\u0142a\u0107 metod\u0119 proceed(), w celu wykonania metody docelowej. Dodatkowo nale\u017cy zadba\u0107 o zwr\u00f3cenie rezultatu wykonanej metody.<\/p>\n\n\n
\n@Around("pointcut()")\npublic Object aroundMethod(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {\n\/\/...\n Object result = proceedingJoinPoint.proceed();\n\/\/...\n return result;\n}\n<\/pre><\/div>\n\n\nDost\u0119p do bie\u017c\u0105cego punktu \u0142\u0105czenia<\/strong><\/h2>\n\n\n\nWszystkie porady maj\u0105 mo\u017cliwo\u015b\u0107 zadeklarowania jako pierwszego parametru obiektu typu JoinPoint. Wyj\u0105tek stanowi porada Around, kt\u00f3ra wymaga zadeklarowania jako pierwszego parametru obiektu typu ProceedingJoinPoint, kt\u00f3ry rozszerza interfejs JoinPoint.<\/p>\n\n\n\n
Parametr JoinPoint w poradzie zapewnia wiele metod, kt\u00f3re mog\u0105 wzbogaci\u0107 implementacj\u0119 naszej porady. Dzi\u0119ki niemu mo\u017cemy na przyk\u0142ad uzyska\u0107 dost\u0119p do sygnatury wywo\u0142ywanej metody JoinPoint::getSignature() oraz jej parametr\u00f3w JoinPoint::getArgs(). ProceedingJoinPoint pozwala dodatkowo sterowa\u0107 wywo\u0142aniem metody ProceedingJoinPoint::proceed().<\/p>\n\n\n\n
Dodanie i konfiguracja zale\u017cno\u015bci Spring AOP w projekcie<\/strong><\/h2>\n\n\n\nPierwsz\u0105 czynno\u015bci\u0105, jak\u0105 nale\u017cy wykona\u0107, aby rozpocz\u0105\u0107 przygod\u0119 z programowaniem aspektowym w frameworku SpringBoot, jest dodanie zale\u017cno\u015bci spring-boot-starter-aop<\/strong> w pliku konfiguracyjnym projektu (build.gradle dla projektu zarz\u0105dzanego przez gradle lub pom.xml w przypadku projektu zarz\u0105dzanego przez maven).<\/p>\n\n\n\n<dependencies>\n <dependency>\n <groupId>org.springframework.boot<\/groupId>\n <artifactId>spring-boot-starter-aop<\/artifactId>\n <\/dependency>\n <!-- kolejne zale\u017cno\u015bci -->\n<\/dependencies>\n<\/pre><\/div>\n\n\nNast\u0119pnie, w klasie konfiguracyjnej, przy u\u017cyciu adnotacji @EnableAspectJAutoProxy<\/strong>, nale\u017cy odblokowa\u0107 wsparcie dla komponent\u00f3w oznaczonych adnotacj\u0105 @Aspect<\/strong>. Wspomnian\u0105 adnotacj\u0119 mo\u017cna doda\u0107 w g\u0142\u00f3wnym pliku konfiguracji aplikacji lub w dowolnym komponencie konfiguracyjnym:<\/p>\n\n\n\n@SpringBootApplication\n@EnableAspectJAutoProxy\npublic class AspectApplication {\n\n public static void main(String[] args) {\n SpringApplication.run(AspectApplication.class, args);\n }\n\n}\n<\/pre><\/div>\n\n\nImplementacje przyk\u0142adowych problem\u00f3w<\/strong><\/h2>\n\n\n\nNa potrzeby artyku\u0142u zaprezentowane zostan\u0105 3 przyk\u0142adowe implementacje aspekt\u00f3w.<\/p>\n\n\n\n
\n- Pierwsza z nich dotyczy\u0107 b\u0119dzie porady typu Before<\/strong>, gdzie dodana zostanie implementacja loguj\u0105ca wywo\u0142anie endpoint\u00f3w w przyk\u0142adowym kontrolerze.<\/li>\n\n\n\n
- Nast\u0119pnie przedstawiona i om\u00f3wiona zostanie implementacja aspektu typu @Around<\/strong> na przyk\u0142adzie logowania czasu trwania wybranych operacji, dodatkowo wykorzystany zostanie desygnator @annotation<\/strong>.<\/li>\n\n\n\n
- Ostatni przyk\u0142ad przedstawia\u0107 b\u0119dzie logowanie sytuacji nadzwyczajnych, gdzie zwr\u00f3cony zosta\u0142 nieobs\u0142u\u017cony wyj\u0105tek. Logowanie przy pomocy aspekt\u00f3w nie jest ich jedynym przeznaczeniem. Jednak na potrzeby prezentacji poszczeg\u00f3lnych typ\u00f3w aspekt\u00f3w, jest w zupe\u0142no\u015bci wystarczaj\u0105ce i w ca\u0142o\u015bci pozwoli skupi\u0107 si\u0119 na omawianej tematyce.<\/li>\n<\/ul>\n\n\n\n
Parametry<\/strong><\/h3>\n\n\n\nPoni\u017cej przedstawiony zostanie kod kontrolera, serwisu, modelu oraz adnotacji, na podstawie kt\u00f3rych stworzone zostan\u0105 aspekty.<\/p>\n\n\n\n
TaxController<\/strong> \u2013 zawiera implementacj\u0119 przyk\u0142adowego kontrolera restowego. Metoda calculateTax zosta\u0142a oznaczona specjalnie stworzon\u0105 adnotacj\u0105 @LogExecutionTime, kt\u00f3ra pos\u0142u\u017cy do prezentacji tworzenia pointcutu z u\u017cyciem desygnatora @annotation.<\/p>\n\n\n\n@RestController\n@RequestMapping("\/tax")\npublic class TaxController {\n\n private final TaxService taxService;\n\n public TaxController(TaxService taxService) {\n this.taxService = taxService;\n }\n\n @GetMapping("\/calculate\/{clientId}")\n @LogExecutionTime\n ResponseEntity<TaxResult> calculateTax(@PathVariable Long clientId) {\n TaxResult result = taxService.calculateTax(clientId);\n return ResponseEntity.ok(result);\n }\n\n}\n<\/pre><\/div>\n\n\nTaxService<\/strong> \u2013 kod przyk\u0142adowej implementacji serwisu, kt\u00f3ry w zale\u017cno\u015bci od przekazanego parametru clientId pozwoli zasymulowa\u0107 3 rodzaje operacji (wywo\u0142anie operacji, operacj\u0119 trwaj\u0105ca d\u0142u\u017cej oraz operacj\u0119 zako\u0144czon\u0105 zg\u0142oszeniem wyj\u0105tku). Tak przygotowana metoda pozwoli w pe\u0142ni przetestowa\u0107 wszystkie stworzone porady.<\/p>\n\n\n\n@Service\npublic class TaxService {\n\n TaxResult calculateTax(Long clientId) {\n if (clientId == 2) {\n throw new IllegalStateException("Calculating for this client is not allowed!");\n }\n if (clientId == 3) {\n sleepFor5Seconds();\n }\n return new TaxResult(clientId);\n }\n\n private void sleepFor5Seconds() {\n try {\n Thread.sleep(5000L);\n } catch (InterruptedException e) {\n e.printStackTrace();\n }\n }\n\n}\n<\/pre><\/div>\n\n\nTaxResult<\/strong> \u2013 prosta klasa modelu wykorzystywanego w przyk\u0142adzie.<\/p>\n\n\n\npublic class TaxResult {\n\n private Long clientId;\n\n private BigDecimal tax;\n\n public TaxResult(Long clientId) {\n this.clientId = clientId;\n }\n\n public TaxResult(Long clientId, BigDecimal tax) {\n this.clientId = clientId;\n this.tax = tax;\n }\n\n public Long getClientId() {\n return clientId;\n }\n\n public void setClientId(Long clientId) {\n this.clientId = clientId;\n }\n\n public BigDecimal getTax() {\n return tax;\n }\n\n public void setTax(BigDecimal tax) {\n this.tax = tax;\n }\n}\n<\/pre><\/div>\n\n\nLogExecutionTime<\/strong> \u2013 kod stworzonej adnotacji, kt\u00f3r\u0105 oznaczono metod\u0119 calculateTax z klasy TaxController.<\/p>\n\n\n\n@Target(ElementType.METHOD)\n@Retention(RetentionPolicy.RUNTIME)\npublic @interface LogExecutionTime {\n}\n<\/pre><\/div>\n\n\nImplementacja przyk\u0142adowych porad<\/strong><\/h2>\n\n\n\nPorada typu @Before przedstawia logowanie wywo\u0142ania ka\u017cdej metody z klasy TaxController. W tym przypadku zaprezentowano przekazywanie definicji pointcutu jako nazwy zdefiniowanej metody. Wykorzystano r\u00f3wnie\u017c pobranie nazwy metody, dla kt\u00f3rej uruchomiona zosta\u0142a porada za po\u015brednictwem metody JoinPoint::getSignature()::getName() oraz przekazanych argument\u00f3w JoinPoint::getArgs().<\/p>\n\n\n
\n@Aspect\n@Component\npublic class TaxAspectBefore {\n\n public static final Logger logger = LoggerFactory.getLogger(TaxAspectBefore.class);\n\n @Pointcut("execution(* pl.demo.spring.TaxController.*(..))")\n void anyMethodOfTaxController() {\n\n }\n\n @Before("anyMethodOfTaxController()")\n void logCallTaxEndpoint(JoinPoint joinPoint) {\n logger.info("Call TaxController endpoint: {} with arguments {}", joinPoint.getSignature().getName(), joinPoint.getArgs());\n }\n\n}\n<\/pre><\/div>\n\n\nPrzy pomocy porady typu @Around zaimplementowane zosta\u0142o logowanie czasu wykonania metody. Metoda ta zosta\u0142a opatrzona adnotacj\u0105 @LogExecutionTime. Wykorzystany do tego celu zosta\u0142 desygnator typu @annotation, kt\u00f3ry jako parametr przyjmuje nazw\u0119 adnotacji wraz z pakietem. Dodatkowo, warto zwr\u00f3ci\u0107 uwag\u0119 na konieczno\u015b\u0107 wykonania metody proceedingJoinPoint.proceed() oraz przypisania do zmiennej i zwr\u00f3cenia jej wyniku.<\/p>\n\n\n
\n@Aspect\n@Component\npublic class TaxAspectAround {\n\n public static final Logger logger = LoggerFactory.getLogger(TaxAspectAround.class);\n\n @Around("@annotation(pl.demo.spring.LogExecutionTime)")\n Object logExecutionTime(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {\n long start = System.currentTimeMillis();\n Object result = proceedingJoinPoint.proceed();\n long duration = (System.currentTimeMillis() - start) \/ 1000;\n logger.info("Execution of method {} took {} s", proceedingJoinPoint.getSignature().getName(), duration);\n return result;\n }\n\n}\n<\/pre><\/div>\n\n\nJako ostatnia przedstawiona zosta\u0142a implementacja dodatkowego logowania w przypadku zg\u0142oszenia wyj\u0105tku przez metod\u0119 calculateTax z serwisu TaxService. Za pomoc\u0105 atrybutu throwing adnotacji @AfterThrowing okre\u015blamy mapowanie zg\u0142oszonego wyj\u0105tku do parametru metody. W logowaniu wykorzystano wcze\u015bniej poznane metody z klasy JoinPoint, a dodatkowo informacje pochodz\u0105ce ze zg\u0142oszonego wyj\u0105tku.<\/p>\n\n\n
\n@Aspect\n@Component\npublic class TaxAspectAfterThrowing {\n\n public static final Logger logger = LoggerFactory.getLogger(TaxAspectAfterThrowing.class);\n\n @AfterThrowing(pointcut = "execution(TaxResult pl.demo.spring.TaxService.calculateTax(Long))", throwing = "exception")\n void logAfterThrowingInCalculateTaxMethod(JoinPoint joinPoint, Exception exception) {\n logger.error("TaxService::calculateTax throw error for clientId: {} with message: {}", joinPoint.getArgs()[0], exception.getMessage());\n }\n\n}\n<\/pre><\/div>\n\n\n
![\"Wizualizacja](\"https:\/\/sii.pl\/blog\/wp-content\/uploads\/2023\/07\/Obraz1-1.png\")
<\/a>