Spring Framework Guide

Материал из Викиучебника — открытых книг для открытого мира
Перейти к: навигация, поиск

Аннотации[править]

@Component - Аннотация для любого компонента фреймворка.

@Service - (Сервис-слой приложения) Аннотация, объявляющая, что этот класс представляет собой сервис – компонент сервис-слоя.

Сервис является подтипом класса @Component. Использование данной аннотации позволит искать бины-сервисы автоматически.

@Repository - (Доменный слой) Аннотация показывает, что класс функционирует как репозиторий и требует наличия прозрачной трансляции исключений. Преимуществом трансляции исключений является то, что слой сервиса будет иметь дело с общей иерархией исключений от Spring (DataAccessException) вне зависимости от используемых технологий доступа к данным в слое данных.

@Controller - (Слой представления) Аннотация для маркировки java класса, как класса контроллера. Данный класс представляет собой компонент, похожий на обычный сервлет (HttpServlet) (работающий с объектами HttpServletRequest и HttpServletResponse), но с расширенными возможностями от Spring Framework.

@ResponseBody - Аннотация показывает что данный метод может возвращать кастомный объект в виде xml, json...

@RestController - Аннотация аккумулирует поведение двух аннотаций @Controller и @ResponseBody

import org.springframework.stereotype.Component;

@Component
public class UserBean {
	private String userName;

	public String getUserName() {
		return userName;
	}

	public void setUserName(String userName) {
		this.userName = userName;
	}
	
	
}

@Transactional - Перед исполнением метода помеченного данной аннотацией начинается транзакция, после выполнения метода транзакция коммитится, при выбрасывании RuntimeException откатывается.

@Autowired - Аннотация позволяет автоматически установить значение поля.

@RequestMapping - Аннотация используется для маппинга урл-адреса запроса на указанный метод или класс. Можно указывать конкретный HTTP-метод, который будет обрабатываться (GET/POST), передавать параметры запроса.

@ModelAttribute - Аннотация, связывающая параметр метода или возвращаемое значение метода с атрибутом модели, которая будет использоваться при выводе jsp-страницы.

@PathVariable - Аннотация, которая показывает, что параметр метода должен быть связан с переменной из урл-адреса.

@Scope - Аннотация для установки области жизни бина: singleton (только один экземпляр бина создается для IoC контейнера; значение по умолчанию ), prototype (создается новый экземпляр бина когда приходит запрос на его создание), request (один экземпляр бина для каждого HTTP запроса ), session (один экземпляр бина для каждой сессии), globalSession (один экземпляр бина для каждой глобальной сессии)

@PostConstruct - Аннотация для метода, который будет вызван после вызова конструктора бина.

@PreDestroy - Аннотация для метода, который будет вызван перед уничтожением бина.

@Profile - Аннотация для создания профилей конфигурации проекта. Может применяться как к бинам так и к конфигурационным классам.

@Configuration
public class AppConfig {

    @Bean
    @Profile("dev")
    public DataSource devDataSource() {
        return new EmbeddedDatabaseBuilder()
            .setType(EmbeddedDatabaseType.HSQL)
            .addScript("classpath:com/bank/config/sql/schema.sql")
            .addScript("classpath:com/bank/config/sql/test-data.sql")
            .build();
    }

    @Bean
    @Profile("production")
    public DataSource productionDataSource() throws Exception {
        Context ctx = new InitialContext();
        return (DataSource) ctx.lookup("java:comp/env/jdbc/datasource");
    }
}

Области видимости бинов[править]

singleton - Возвращает один и тот же экземпляр бина на каждый запрос контейнера Spring IoC (по умолчанию).

prototype - Создает и возвращает новый экземпляр бина на каждый запрос.

request - Создает и возвращает экземпляр бина на каждый HTTP запрос*.

session - Создает и возвращает экземпляр бина для каждой HTTP сессии*.

global-session - Создает и возвращает экземпляр бина для глобальной HTTP сессии*.


  • Only valid in the context of a web-aware Spring ApplicationContext.

Пример:

import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Service;
 
@Service
@Scope("prototype")
public class UserService 
{
	String message;
 
	public String getMessage() {
		return message;
	}
 
	public void setMessage(String message) {
		this.message = message;
	}
}

Конфигурация, Контекст[править]

Контекст приложения(org.springframework.context.ApplicationContext interface):

FileSystemXmlApplicationContext: Загружает определения бинов из файла контекста который расположен в файловой системе.

ClassPathXmlApplicationContext: Ищет файл контекста в CLASSPATH.

WebXmlApplicationContext: Ищет файл контекста в веб приложении.


import org.springframework.context.ApplicationContext;
import org.springframework.context.support.FileSystemXmlApplicationContext;

public class Main {
	public static void main(String[] args) {
		String fileName = "spring/appServlet/servlet-context.xml";
		ApplicationContext context = new FileSystemXmlApplicationContext("src/main/webapp/WEB-INF/"+fileName);
		
		UserBean bean = (UserBean) context.getBean("userBean");
		bean.setUserName("alec");
		System.out.println("user:"+bean.getUserName());
	}
}

Шаблоны компонентов[править]