2022-03 spring-06-bean-scopes-and-lifecycle added

This commit is contained in:
stvort
2023-04-13 01:17:30 +04:00
parent a37a8321d4
commit 13b043f0fc
53 changed files with 1262 additions and 0 deletions
@@ -0,0 +1,4 @@
.idea/
*.iml
target/
@@ -0,0 +1,32 @@
# Compiled class file
*.class
# Log file
*.log
# BlueJ files
*.ctxt
# Mobile Tools for Java (J2ME)
.mtj.tmp/
# Package Files #
*.jar
*.war
*.ear
*.zip
*.tar.gz
*.rar
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*
#other
*.bat
*/.idea
*.iml
*/target
.idea
*.iml
target
@@ -0,0 +1,19 @@
#### Упражнение №2
- Изучить классы ничего в них не меняя:
- CustomBeanFactoryPostProcessor
- CustomBeanPostProcessor
- CustomLifeCycleBean
- Запуститить приложение
- Изучить распечатанный жизненный цикл
#### Упражнение №3
- В application.yml выставить spring.shell.interactive.enabled в true
- Запуститить приложение командой "cfn" или "call-favorite-number"
- Запомнить результат
- В CustomBeanFactoryPostProcessor раскомментировать блок кода
- Запуститить приложение командой "cfn" или "call-favorite-number"
- Что изменилось?
- В CustomBeanPostProcessor раскомментировать строку
- Запуститить приложение командой "cfn" или "call-favorite-number"
- Что изменилось теперь? Круто, да?
@@ -0,0 +1,50 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<!--
<version>2.7.8</version>
-->
<version>3.0.5</version>
<relativePath/>
</parent>
<groupId>ru.otus.example</groupId>
<artifactId>beans-lifecycle-exercise</artifactId>
<version>0.0.1-SNAPSHOT</version>
<properties>
<!--
<java.version>11</java.version>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
-->
<java.version>17</java.version>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
@@ -0,0 +1,20 @@
package ru.otus.example.beanslifecycledemo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContext;
import ru.otus.example.beanslifecycledemo.domain.Phone;
@SpringBootApplication
public class BeansLifecycleDemoApplication {
public static void main(String[] args) {
ApplicationContext ctx = SpringApplication.run(BeansLifecycleDemoApplication.class, args);
try {
Phone phone = ctx.getBean(Phone.class);
phone.callFavoriteNumber();
}catch (Exception e) {
}
}
}
@@ -0,0 +1,8 @@
package ru.otus.example.beanslifecycledemo.domain;
public class FriendPhoneNumber extends PhoneNumber {
@Override
public String getOwnerName() {
return "Друг";
}
}
@@ -0,0 +1,11 @@
package ru.otus.example.beanslifecycledemo.domain;
import org.springframework.stereotype.Component;
@Component
public class GirlfiendPhoneNumber extends PhoneNumber {
@Override
public String getOwnerName() {
return "Подруга";
}
}
@@ -0,0 +1,18 @@
package ru.otus.example.beanslifecycledemo.domain;
import lombok.RequiredArgsConstructor;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.stereotype.Component;
@Component
@ConditionalOnProperty(name = "lifecycle.print.enabled", havingValue = "false")
@RequiredArgsConstructor
public class Phone {
private String greeting = "Погнали к родителям";
private final PhoneNumber favoriteNumber;
public void callFavoriteNumber() {
System.out.println(favoriteNumber.getOwnerName() + " " + greeting);
}
}
@@ -0,0 +1,7 @@
package ru.otus.example.beanslifecycledemo.domain;
public abstract class PhoneNumber {
public String getOwnerName() {
return "Спорт-лото";
}
}
@@ -0,0 +1,62 @@
package ru.otus.example.beanslifecycledemo.lifecycle;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.BeanNameGenerator;
import org.springframework.beans.factory.support.GenericBeanDefinition;
import org.springframework.context.EnvironmentAware;
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
import org.springframework.core.env.Environment;
import org.springframework.core.type.AnnotationMetadata;
import java.util.Optional;
public class CustomBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar, EnvironmentAware {
private Environment environment;
@Override
public void setEnvironment(Environment environment) {
this.environment = environment;
}
@Override
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata,
BeanDefinitionRegistry registry,
BeanNameGenerator importBeanNameGenerator) {
registerBeanDefinitions(importingClassMetadata, registry);
}
@Override
public void registerBeanDefinitions(AnnotationMetadata metadata,
BeanDefinitionRegistry registry) {
registerBeanFactoryPostProcessor(registry);
registerBeanPostProcessor(registry);
if (Optional.ofNullable(environment.getProperty("lifecycle.print.enabled", Boolean.class)).orElse(false)) {
System.out.println("Шаг #0: ImportBeanDefinitionRegistrar.registerBeanDefinitions\n");
registerCustomLifeCycleBean(registry);
}
}
private void registerCustomLifeCycleBean(BeanDefinitionRegistry registry) {
GenericBeanDefinition gbd = new GenericBeanDefinition();
gbd.setBeanClass(CustomLifeCycleBean.class);
gbd.setInitMethodName("customInitMethod");
gbd.setDestroyMethodName("customDestroyMethod");
registry.registerBeanDefinition("customLifeCycleBean", gbd);
}
private void registerBeanFactoryPostProcessor(BeanDefinitionRegistry registry) {
GenericBeanDefinition gbd = new GenericBeanDefinition();
gbd.setBeanClass(CustomBeanFactoryPostProcessor.class);
registry.registerBeanDefinition("customBeanFactoryPostProcessor", gbd);
}
private void registerBeanPostProcessor(BeanDefinitionRegistry registry) {
GenericBeanDefinition gbd = new GenericBeanDefinition();
gbd.setBeanClass(CustomBeanPostProcessor.class);
registry.registerBeanDefinition("customBeanPostProcessor", gbd);
}
}
@@ -0,0 +1,32 @@
package ru.otus.example.beanslifecycledemo.lifecycle;
import org.springframework.beans.BeanMetadataAttribute;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.context.annotation.ScannedGenericBeanDefinition;
import ru.otus.example.beanslifecycledemo.domain.FriendPhoneNumber;
import ru.otus.example.beanslifecycledemo.domain.GirlfiendPhoneNumber;
public class CustomBeanFactoryPostProcessor implements BeanFactoryPostProcessor {
@Override
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
if (beanFactory.containsBean("customLifeCycleBean")) {
System.out.println("Шаг #1: BeanFactoryPostProcessor.postProcessBeanFactory\n");
}
/*
for (String beanName : beanFactory.getBeanDefinitionNames()) {
BeanDefinition d = beanFactory.getBeanDefinition(beanName);
if (GirlfiendPhoneNumber.class.getName().equalsIgnoreCase(d.getBeanClassName())) {
d.setBeanClassName(FriendPhoneNumber.class.getName());
((ScannedGenericBeanDefinition) d).addMetadataAttribute(new BeanMetadataAttribute("className", FriendPhoneNumber.class.getName()));
d.setAutowireCandidate(true);
}
}
*/
}
}
@@ -0,0 +1,48 @@
package ru.otus.example.beanslifecycledemo.lifecycle;
import org.springframework.beans.BeansException;
import org.springframework.beans.InvalidPropertyException;
import org.springframework.beans.factory.config.BeanPostProcessor;
import ru.otus.example.beanslifecycledemo.domain.Phone;
import java.lang.reflect.Field;
public class CustomBeanPostProcessor implements BeanPostProcessor {
public static final String GREETING_PROPERTY = "greeting";
@Override
public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
if (bean.getClass().equals(CustomLifeCycleBean.class)) {
System.out.println("Шаг #5: BeanPostProcessor.postProcessBeforeInitialization\n");
}
return bean;
}
@Override
public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
if (bean.getClass().equals(CustomLifeCycleBean.class)) {
System.out.println("Шаг #9: BeanPostProcessor.postProcessAfterInitialization\n");
}
/*
if (bean.getClass().isAssignableFrom(Phone.class)) {
updateGreeting(bean);
}
*/
return bean;
}
private void updateGreeting(Object bean) {
Class<?> aClass = Phone.class;
try {
Field greetingField = aClass.getDeclaredField(GREETING_PROPERTY);
greetingField.setAccessible(true);
greetingField.set(bean, "Ай-да в гараж. Стихи читать!");
} catch (Exception e) {
throw new InvalidPropertyException(Phone.class, GREETING_PROPERTY,
"Bean class does not have expected property", e);
}
}
}
@@ -0,0 +1,60 @@
package ru.otus.example.beanslifecycledemo.lifecycle;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.*;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
/*
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
*/
import jakarta.annotation.PostConstruct;
import jakarta.annotation.PreDestroy;
public class CustomLifeCycleBean implements InitializingBean, DisposableBean, BeanNameAware,
BeanFactoryAware, ApplicationContextAware {
@Override
public void setBeanName(String s) {
System.out.println("Шаг #2: BeanNameAware\n");
}
@Override
public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
System.out.println("Шаг #3: BeanFactoryAware\n");
}
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
System.out.println("Шаг #4: ApplicationContextAware\n");
}
@PostConstruct
public void postConstruct() {
System.out.println("Шаг #6: @PostConstruct\n");
}
@Override
public void afterPropertiesSet() throws Exception {
System.out.println("Шаг #7: InitializingBean.afterPropertiesSet\n");
}
public void customInitMethod() {
System.out.println("Шаг #8: CustomLifeCycleBean.customInitMethod\n");
}
@PreDestroy
public void preDestroy() {
System.out.println("Шаг #10: @PreDestroy\n");
}
@Override
public void destroy() throws Exception {
System.out.println("Шаг #11: DisposableBean.destroy\n");
}
public void customDestroyMethod() {
System.out.println("Шаг #12: CustomLifeCycleBean.customDestroyMethod\n");
}
}
@@ -0,0 +1,30 @@
package ru.otus.example.beanslifecycledemo.lifecycle;
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
import org.springframework.beans.factory.config.BeanPostProcessor;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
@Import(CustomBeanDefinitionRegistrar.class)
@Configuration
public class LifeCycleConfig {
/*
@Bean
public BeanFactoryPostProcessor customBeanFactoryPostProcessor() {
return new CustomBeanFactoryPostProcessor();
}
@Bean
public BeanPostProcessor customBeanPostProcessor() {
return new CustomBeanPostProcessor();
}
@ConditionalOnProperty(name = "lifecycle.print.enabled", havingValue = "true")
@Bean(initMethod = "customInitMethod", destroyMethod = "customDestroyMethod")
public CustomLifeCycleBean customLifeCycleBean() {
return new CustomLifeCycleBean();
}
*/
}
@@ -0,0 +1,7 @@
logging:
level:
root: ERROR
lifecycle:
print:
enabled: true
@@ -0,0 +1,32 @@
# Compiled class file
*.class
# Log file
*.log
# BlueJ files
*.ctxt
# Mobile Tools for Java (J2ME)
.mtj.tmp/
# Package Files #
*.jar
*.war
*.ear
*.zip
*.tar.gz
*.rar
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*
#other
*.bat
*/.idea
*.iml
*/target
.idea
*.iml
target
@@ -0,0 +1,9 @@
#### Упражнение №1
- Расставить скоупы над сервисами так, чтобы приложение запустилось и заработало, как указано на странице http://localhost:8080
- Подсказки в названии сервисов
- Не забываем про proxyMode для некоторых скоупов
```
Задать скоуп можно с помощью аннотации @Scope
Возможные значения: singleton, prototype, session, request
```
@@ -0,0 +1,56 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<!--
<version>2.7.8</version>
-->
<version>3.0.5</version>
<relativePath/>
</parent>
<groupId>ru.otus.example</groupId>
<artifactId>beans-scopes-exercise</artifactId>
<version>0.0.1-SNAPSHOT</version>
<properties>
<!--
<java.version>11</java.version>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
-->
<java.version>17</java.version>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
@@ -0,0 +1,15 @@
package ru.otus.example.beansscopesdemo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class BeansScopesDemoApplication {
public static void main(String[] args) {
var ctx = SpringApplication.run(BeansScopesDemoApplication.class, args);
var serverPort = ctx.getEnvironment().getProperty("local.server.port");
System.out.printf("Чтобы смотреть результат переходи сюда: http://localhost:%s", serverPort);
}
}
@@ -0,0 +1,41 @@
package ru.otus.example.beansscopesdemo.controllers;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import ru.otus.example.beansscopesdemo.services.GreetingService;
@Controller
public class GreetingController {
private final GreetingService singletonGreetingService;
private final GreetingService prototypeGreetingService1;
private final GreetingService prototypeGreetingService2;
private final GreetingService sessionGreetingService;
private final GreetingService requestGreetingService;
public GreetingController(GreetingService singletonGreetingService,
@Qualifier("prototypeGreetingService")
GreetingService prototypeGreetingService1,
@Qualifier("prototypeGreetingService")
GreetingService prototypeGreetingService2,
GreetingService sessionGreetingService,
GreetingService requestGreetingService
) {
this.singletonGreetingService = singletonGreetingService;
this.prototypeGreetingService1 = prototypeGreetingService1;
this.prototypeGreetingService2 = prototypeGreetingService2;
this.sessionGreetingService = sessionGreetingService;
this.requestGreetingService = requestGreetingService;
}
@GetMapping("/")
public String greetingPage(Model model) {
model.addAttribute("singletonGreeting", singletonGreetingService.greeting());
model.addAttribute("sessionGreeting", sessionGreetingService.greeting());
model.addAttribute("requestGreeting", requestGreetingService.greeting());
model.addAttribute("prototype1Greeting", prototypeGreetingService1.greeting());
model.addAttribute("prototype2Greeting", prototypeGreetingService2.greeting());
return "index";
}
}
@@ -0,0 +1,23 @@
package ru.otus.example.beansscopesdemo.services;
import java.util.concurrent.atomic.AtomicInteger;
public abstract class AbstractGreetingServiceImpl implements GreetingService {
private final AtomicInteger counter;
public AbstractGreetingServiceImpl() {
this.counter = new AtomicInteger(0);
}
@Override
public String greeting() {
return currentGreeting();
}
private String currentGreeting() {
return String.format("Привет! Это наша встреча №%d. Меня зовут: %s",
counter.incrementAndGet(), Integer.toHexString(hashCode()));
}
}
@@ -0,0 +1,5 @@
package ru.otus.example.beansscopesdemo.services;
public interface GreetingService {
String greeting();
}
@@ -0,0 +1,7 @@
package ru.otus.example.beansscopesdemo.services;
import org.springframework.stereotype.Service;
@Service("prototypeGreetingService")
public class PrototypeGreetingServiceImpl extends AbstractGreetingServiceImpl {
}
@@ -0,0 +1,7 @@
package ru.otus.example.beansscopesdemo.services;
import org.springframework.stereotype.Service;
@Service("requestGreetingService")
public class RequestGreetingServiceImpl extends AbstractGreetingServiceImpl {
}
@@ -0,0 +1,7 @@
package ru.otus.example.beansscopesdemo.services;
import org.springframework.stereotype.Service;
@Service("sessionGreetingService")
public class SessionGreetingServiceImpl extends AbstractGreetingServiceImpl {
}
@@ -0,0 +1,7 @@
package ru.otus.example.beansscopesdemo.services;
import org.springframework.stereotype.Service;
@Service("singletonGreetingService")
public class SingletonGreetingServiceImpl extends AbstractGreetingServiceImpl {
}
@@ -0,0 +1,3 @@
logging:
level:
root: ERROR
@@ -0,0 +1,45 @@
<!DOCTYPE html>
<html lang="ru" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>Advanced configuration demo</title>
<style>
body {
font-size: 16pt;
}
h3 {
color: CornflowerBlue;
}
li {
color: DarkGray;
}
p {
color: OrangeRed;
font-weight: bold;
}
</style>
</head>
<body>
<p>
<h3>Демонстрация @Scope</h3>
<ul>
<li>Singleton должен постоянно накручивать счетчик встреч и не менять имя</li>
<li>Prototype1 должен вести себя так же, как и Singleton, но иметь имя отличное от Prototype2</li>
<li>Prototype2 должен вести себя так же, как и Singleton, но иметь имя отличное от Prototype1</li>
<li>Session должен вести себя как Singleton, но только до перезапуска браузера. После, счетчик встреч должен пойти заново</li>
<li>Request должен всегда показывать первую встречу и разное имя</li>
</ul>
</p>
<hr/>
<p th:text = "'Singleton сказал: ' + ${singletonGreeting}"></p>
<p th:text = "'Prototype1 сказал: ' + ${prototype1Greeting}"></p>
<p th:text = "'Prototype2 сказал: ' + ${prototype2Greeting}"></p>
<p th:text = "'Session сказал: ' + ${sessionGreeting}"></p>
<p th:text = "'Request сказал: ' + ${requestGreeting}"></p>
</body>
</html>
@@ -0,0 +1,32 @@
# Compiled class file
*.class
# Log file
*.log
# BlueJ files
*.ctxt
# Mobile Tools for Java (J2ME)
.mtj.tmp/
# Package Files #
*.jar
*.war
*.ear
*.zip
*.tar.gz
*.rar
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*
#other
*.bat
*/.idea
*.iml
*/target
.idea
*.iml
target
@@ -0,0 +1,15 @@
#### Решение к упражнению №1
@Scope("singleton")
SingletonGreetingServiceImpl
@Scope("prototype")
PrototypeGreetingServiceImpl
@Scope(value = "request", proxyMode = ScopedProxyMode.INTERFACES)
RequestGreetingServiceImpl
@Scope(value = "session", proxyMode = ScopedProxyMode.INTERFACES)
SessionGreetingServiceImpl
@@ -0,0 +1,56 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<!--
<version>2.7.8</version>
-->
<version>3.0.5</version>
<relativePath/>
</parent>
<groupId>ru.otus.example</groupId>
<artifactId>beans-scopes-solution</artifactId>
<version>0.0.1-SNAPSHOT</version>
<properties>
<!--
<java.version>11</java.version>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
-->
<java.version>17</java.version>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
@@ -0,0 +1,15 @@
package ru.otus.example.beansscopesdemo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class BeansScopesDemoApplication {
public static void main(String[] args) {
var ctx = SpringApplication.run(BeansScopesDemoApplication.class, args);
var serverPort = ctx.getEnvironment().getProperty("local.server.port");
System.out.printf("Чтобы смотреть результат переходи сюда: http://localhost:%s", serverPort);
}
}
@@ -0,0 +1,41 @@
package ru.otus.example.beansscopesdemo.controllers;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import ru.otus.example.beansscopesdemo.services.GreetingService;
@Controller
public class GreetingController {
private final GreetingService singletonGreetingService;
private final GreetingService prototypeGreetingService1;
private final GreetingService prototypeGreetingService2;
private final GreetingService sessionGreetingService;
private final GreetingService requestGreetingService;
public GreetingController(GreetingService singletonGreetingService,
@Qualifier("prototypeGreetingService")
GreetingService prototypeGreetingService1,
@Qualifier("prototypeGreetingService")
GreetingService prototypeGreetingService2,
GreetingService sessionGreetingService,
GreetingService requestGreetingService
) {
this.singletonGreetingService = singletonGreetingService;
this.prototypeGreetingService1 = prototypeGreetingService1;
this.prototypeGreetingService2 = prototypeGreetingService2;
this.sessionGreetingService = sessionGreetingService;
this.requestGreetingService = requestGreetingService;
}
@GetMapping("/")
public String greetingPage(Model model) {
model.addAttribute("singletonGreeting", singletonGreetingService.greeting());
model.addAttribute("sessionGreeting", sessionGreetingService.greeting());
model.addAttribute("requestGreeting", requestGreetingService.greeting());
model.addAttribute("prototype1Greeting", prototypeGreetingService1.greeting());
model.addAttribute("prototype2Greeting", prototypeGreetingService2.greeting());
return "index";
}
}
@@ -0,0 +1,23 @@
package ru.otus.example.beansscopesdemo.services;
import java.util.concurrent.atomic.AtomicInteger;
public abstract class AbstractGreetingServiceImpl implements GreetingService {
private final AtomicInteger counter;
public AbstractGreetingServiceImpl() {
this.counter = new AtomicInteger(0);
}
@Override
public String greeting() {
return currentGreeting();
}
private String currentGreeting() {
return String.format("Привет! Это наша встреча №%d. Меня зовут: %s",
counter.incrementAndGet(), Integer.toHexString(hashCode()));
}
}
@@ -0,0 +1,5 @@
package ru.otus.example.beansscopesdemo.services;
public interface GreetingService {
String greeting();
}
@@ -0,0 +1,10 @@
package ru.otus.example.beansscopesdemo.services;
import org.springframework.context.annotation.Scope;
import org.springframework.context.annotation.ScopedProxyMode;
import org.springframework.stereotype.Service;
@Scope(scopeName = "prototype")
@Service("prototypeGreetingService")
public class PrototypeGreetingServiceImpl extends AbstractGreetingServiceImpl {
}
@@ -0,0 +1,11 @@
package ru.otus.example.beansscopesdemo.services;
import org.springframework.context.annotation.Scope;
import org.springframework.context.annotation.ScopedProxyMode;
import org.springframework.stereotype.Service;
import org.springframework.web.context.WebApplicationContext;
@Scope(value = "request", proxyMode = ScopedProxyMode.INTERFACES)
@Service("requestGreetingService")
public class RequestGreetingServiceImpl extends AbstractGreetingServiceImpl {
}
@@ -0,0 +1,11 @@
package ru.otus.example.beansscopesdemo.services;
import org.springframework.context.annotation.Scope;
import org.springframework.context.annotation.ScopedProxyMode;
import org.springframework.stereotype.Service;
import org.springframework.web.context.WebApplicationContext;
@Scope(value = "session", proxyMode = ScopedProxyMode.INTERFACES)
@Service("sessionGreetingService")
public class SessionGreetingServiceImpl extends AbstractGreetingServiceImpl {
}
@@ -0,0 +1,9 @@
package ru.otus.example.beansscopesdemo.services;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Service;
@Scope("singleton")
@Service("singletonGreetingService")
public class SingletonGreetingServiceImpl extends AbstractGreetingServiceImpl {
}
@@ -0,0 +1,3 @@
logging:
level:
root: ERROR
@@ -0,0 +1,45 @@
<!DOCTYPE html>
<html lang="ru" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>Advanced configuration demo</title>
<style>
body {
font-size: 16pt;
}
h3 {
color: CornflowerBlue;
}
li {
color: DarkGray;
}
p {
color: OrangeRed;
font-weight: bold;
}
</style>
</head>
<body>
<p>
<h3>Демонстрация @Scope</h3>
<ul>
<li>Singleton должен постоянно накручивать счетчик встреч и не менять имя</li>
<li>Prototype1 должен вести себя так же, как и Singleton, но иметь имя отличное от Prototype2</li>
<li>Prototype2 должен вести себя так же, как и Singleton, но иметь имя отличное от Prototype1</li>
<li>Session должен вести себя как Singleton, но только до перезапуска браузера. После, счетчик встреч должен пойти заново</li>
<li>Request должен всегда показывать первую встречу и разное имя</li>
</ul>
</p>
<hr/>
<p th:text = "'Singleton сказал: ' + ${singletonGreeting}"></p>
<p th:text = "'Prototype1 сказал: ' + ${prototype1Greeting}"></p>
<p th:text = "'Prototype2 сказал: ' + ${prototype2Greeting}"></p>
<p th:text = "'Session сказал: ' + ${sessionGreeting}"></p>
<p th:text = "'Request сказал: ' + ${requestGreeting}"></p>
</body>
</html>
@@ -0,0 +1,33 @@
HELP.md
target/
!.mvn/wrapper/maven-wrapper.jar
!**/src/main/**/target/
!**/src/test/**/target/
### STS ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
### IntelliJ IDEA ###
.idea
*.iws
*.iml
*.ipr
### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/
build/
!**/src/main/**/build/
!**/src/test/**/build/
### VS Code ###
.vscode/
@@ -0,0 +1,3 @@
#### Демо создания собственного Scope
В зависимости от значения поля `canTakeVacation` класса `VacationCalendar`, бин отпуска либо доступен, либо нет
@@ -0,0 +1,51 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<!--
<version>2.7.8</version>
-->
<version>3.0.5</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>ru.otus</groupId>
<artifactId>custom-scope-demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>custom-scope-demo</name>
<description>Custom scope demo</description>
<properties>
<!--
<java.version>11</java.version>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
-->
<java.version>17</java.version>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
@@ -0,0 +1,28 @@
package ru.otus.customscopedemo;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import ru.otus.customscopedemo.scope.VacationDoesNotAvailableException;
import ru.otus.customscopedemo.vacation.Vacation;
import ru.otus.customscopedemo.vacation.VacationCalendar;
@SpringBootApplication
public class CustomScopeDemoApplication {
private static final Logger logger = LoggerFactory.getLogger(CustomScopeDemoApplication.class);
public static void main(String[] args) {
var ctx = SpringApplication.run(CustomScopeDemoApplication.class, args);
var vacationCalendar = ctx.getBean(VacationCalendar.class);
var vacation = ctx.getBean(Vacation.class);
vacationCalendar.setCanTakeVacation(true);
try {
vacation.enjoy();
} catch (VacationDoesNotAvailableException e) {
logger.info("Извини Добби, твой отпуск в другом замке!");
}
}
}
@@ -0,0 +1,4 @@
package ru.otus.customscopedemo.scope;
public class VacationDoesNotAvailableException extends RuntimeException {
}
@@ -0,0 +1,70 @@
package ru.otus.customscopedemo.scope;
import org.springframework.beans.factory.ObjectFactory;
import org.springframework.beans.factory.config.Scope;
import ru.otus.customscopedemo.vacation.VacationCalendar;
import java.util.HashMap;
import java.util.Map;
public class VacationScope implements Scope {
private final Map<String, Runnable> destructionCallbacks;
private final Map<String, Object> contextualObjects;
private final VacationCalendar vacationCalendar;
public VacationScope(VacationCalendar vacationCalendar) {
this.destructionCallbacks = new HashMap<>();
this.contextualObjects = new HashMap<>();
this.vacationCalendar = vacationCalendar;
}
// This is the central operation of a Scope, and the only operation that is absolutely required.
@Override
public Object get(String name, ObjectFactory<?> objectFactory) {
var res = resolveContextualObject(name);
if (res != null) {
return res;
}
if (vacationCalendar.isCanTakeVacation()) {
res = objectFactory.getObject();
contextualObjects.put(name, res);
return res;
}
throw new VacationDoesNotAvailableException();
}
// Note: This is an optional operation. Implementations may throw UnsupportedOperationException
// if they do not support explicitly removing an object.
@Override
public Object remove(String name) {
destructionCallbacks.remove(name);
return contextualObjects.remove(name);
}
@Override
public void registerDestructionCallback(String name, Runnable runnable) {
destructionCallbacks.put(name, runnable);
}
@Override
public Object resolveContextualObject(String name) {
if (!vacationCalendar.isCanTakeVacation() && contextualObjects.containsKey(name)) {
remove(name);
}
return contextualObjects.get(name);
}
@Override
public String getConversationId() {
return null;
}
public void onDestroy() {
destructionCallbacks.values().forEach(Runnable::run);
}
}
@@ -0,0 +1,22 @@
package ru.otus.customscopedemo.scope;
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.DependsOn;
import ru.otus.customscopedemo.vacation.VacationCalendar;
@Configuration
public class VacationScopeConfig {
@Bean(destroyMethod = "onDestroy")
public VacationScope vacationScope(VacationCalendar vacationCalendar){
return new VacationScope(vacationCalendar);
}
@DependsOn("vacationScope")
@Bean
public BeanFactoryPostProcessor vacationScopeRegistrationBeanFactoryPostProcessor(VacationScope vacationScope) {
return new VacationScopeRegistrationBeanFactoryPostProcessor(vacationScope);
}
}
@@ -0,0 +1,19 @@
package ru.otus.customscopedemo.scope;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
public class VacationScopeRegistrationBeanFactoryPostProcessor implements BeanFactoryPostProcessor {
private final VacationScope scope;
public VacationScopeRegistrationBeanFactoryPostProcessor(VacationScope scope) {
this.scope = scope;
}
@Override
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
beanFactory.registerScope("vacation", scope);
}
}
@@ -0,0 +1,48 @@
package ru.otus.customscopedemo.vacation;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Scope;
import org.springframework.context.annotation.ScopedProxyMode;
import org.springframework.stereotype.Component;
//import javax.annotation.PreDestroy;
import jakarta.annotation.PreDestroy;
import java.time.LocalDateTime;
import java.util.Random;
@Scope(value = "vacation", proxyMode = ScopedProxyMode.TARGET_CLASS)
@Component
public class Vacation {
private static final Logger logger = LoggerFactory.getLogger(Vacation.class);
private static final String[] actions = {"спит", "ест", "пьет"};
private static final int VACATION_DURATION_SECONDS = 4;
public void enjoy(){
logger.info("Отпуск начат");
var random = new Random();
var startTime = LocalDateTime.now().plusSeconds(VACATION_DURATION_SECONDS);
while (LocalDateTime.now().isBefore(startTime)) {
var actionIndex = random.nextInt(3);
logger.info("Отдыхающий - {}", actions[actionIndex]);
sleep();
}
logger.info("Отпуск закончен (гаснет свет)");
}
private void sleep() {
try {
Thread.sleep(100);
} catch (InterruptedException e) {
e.printStackTrace();
}
}
@PreDestroy
private void destroyMethod(){
logger.info("Бин отпуска уничтожен");
}
}
@@ -0,0 +1,21 @@
package ru.otus.customscopedemo.vacation;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
@Component
public class VacationCalendar {
private static final Logger logger = LoggerFactory.getLogger(VacationCalendar.class);
private boolean canTakeVacation = false;
public boolean isCanTakeVacation() {
return canTakeVacation;
}
public void setCanTakeVacation(boolean canTakeVacation) {
logger.info("Заявление на отпуск {}", canTakeVacation? "одобрено": "отклонено");
this.canTakeVacation = canTakeVacation;
}
}
@@ -0,0 +1,3 @@
spring:
main:
allow-circular-references: true
@@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>ru.otus</groupId>
<artifactId>advanced-config-class-work</artifactId>
<version>1.0</version>
<packaging>pom</packaging>
<modules>
<module>beans-scopes-exercise</module>
<module>beans-scopes-solution</module>
<module>beans-lifecycle-exercise</module>
<module>custom-scope-demo</module>
</modules>
</project>