First commit
This commit is contained in:
commit
7da12ead47
32
.gitignore
vendored
Normal file
32
.gitignore
vendored
Normal file
@ -0,0 +1,32 @@
|
||||
target/
|
||||
!.mvn/wrapper/maven-wrapper.jar
|
||||
!**/src/main/**/target/
|
||||
!**/src/test/**/target/
|
||||
|
||||
### IntelliJ IDEA ###
|
||||
.idea
|
||||
|
||||
### Eclipse ###
|
||||
.apt_generated
|
||||
.classpath
|
||||
.factorypath
|
||||
.project
|
||||
.settings
|
||||
.springBeans
|
||||
.sts4-cache
|
||||
|
||||
### NetBeans ###
|
||||
/nbproject/private/
|
||||
/nbbuild/
|
||||
/dist/
|
||||
/nbdist/
|
||||
/.nb-gradle/
|
||||
build/
|
||||
!**/src/main/**/build/
|
||||
!**/src/test/**/build/
|
||||
|
||||
### VS Code ###
|
||||
.vscode/
|
||||
|
||||
### Mac OS ###
|
||||
.DS_Store
|
||||
11
NTOBack.iml
Normal file
11
NTOBack.iml
Normal file
@ -0,0 +1,11 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<module type="JAVA_MODULE" version="4">
|
||||
<component name="NewModuleRootManager" inherit-compiler-output="true">
|
||||
<exclude-output />
|
||||
<content url="file://$MODULE_DIR$">
|
||||
<sourceFolder url="file://$MODULE_DIR$/src/main/java" isTestSource="false" />
|
||||
</content>
|
||||
<orderEntry type="inheritedJdk" />
|
||||
<orderEntry type="sourceFolder" forTests="false" />
|
||||
</component>
|
||||
</module>
|
||||
57
pom.xml
Normal file
57
pom.xml
Normal file
@ -0,0 +1,57 @@
|
||||
<?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>org.example</groupId>
|
||||
<artifactId>NTO-2024</artifactId>
|
||||
<version>1.0-SNAPSHOT</version>
|
||||
|
||||
<properties>
|
||||
<maven.compiler.source>11</maven.compiler.source>
|
||||
<maven.compiler.target>11</maven.compiler.target>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
</properties>
|
||||
|
||||
<parent>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-starter-parent</artifactId>
|
||||
<version>2.5.5</version>
|
||||
</parent>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>org.projectlombok</groupId>
|
||||
<artifactId>lombok</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-starter-web</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.h2database</groupId>
|
||||
<artifactId>h2</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-starter-data-jpa</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springdoc</groupId>
|
||||
<artifactId>springdoc-openapi-ui</artifactId>
|
||||
<version>1.7.0</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.junit.jupiter</groupId>
|
||||
<artifactId>junit-jupiter-engine</artifactId>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-starter-test</artifactId>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
</project>
|
||||
84
readme.md
Normal file
84
readme.md
Normal file
@ -0,0 +1,84 @@
|
||||
# НТО 2024. II отборочный этап. Командные задания — серверная часть
|
||||
|
||||
## 📖 Предыстория
|
||||
|
||||
В компании S контроль доступа в офис осуществляется с помощью СКУД (системы контроля управления доступом). На данный
|
||||
момент у каждого сотрудника компании есть карта-пропуск с NFC меткой. А у каждой входной двери есть считыватель с обеих
|
||||
сторон. При поднесении карты к считывателю, дверь открывается, а информация о времени входа или выхода сотрудника
|
||||
фиксируется в базе данных.
|
||||
Администрации компании S требуется мобильное приложение, как для рядовых сотрудников, так и для администрации с
|
||||
возможностью просмотра посещений и работой электронного пропуска как временной замены обычного (при помощи сканировании
|
||||
QR кода, который находится на считывателе). Поскольку в приложении есть возможность использовать телефон как пропуск -
|
||||
то к данному приложению повышенные требования к безопасности всех данных, находящихся внутри него.
|
||||
|
||||
## 🛠️ Техническое задание
|
||||
|
||||
Требуется разработать серверное приложение на Java (Java 11) с использованием Spring Boot, которое работает на основе
|
||||
протоколов TCP/IP и взаимодействует с клиентами благодаря RESTful API. Для хранения данных о сотрудниках и их посещениях
|
||||
должна использоваться реляционная база данных (H2). Сотрудникам не нужно регистрироваться, все данные в базе должны быть
|
||||
предзаполнены. Картинки для аватаров пользователей не должны храниться в БД. Должны быть сохранены лишь URL-адреса на
|
||||
ресурсы, откуда в последующем мобильное приложение загрузит соответствующий аватар.
|
||||
|
||||
Сервер разрабатывается на основе предоставляемой заготовки проекта. Версии зависимостей и сами зависимости изменяться не
|
||||
должны.
|
||||
|
||||
## 📂 Правила работы с проектом-заготовкой
|
||||
|
||||
В предоставленном проекте необходимо изучить, но никак не модифицировать, не перемещать и не удалять следующие файлы:
|
||||
|
||||
- `pom.xml`
|
||||
- `application.yml`
|
||||
- все файлы из `db.changelog`
|
||||
|
||||
Кроме описанных выше файлов, в проекте уже созданы основные классы-сущности и добавлены пустые классы всех слоев. В этих
|
||||
классах необходимо будет написать программный код и добавить аннотации для реализации описанного задания. Наименования
|
||||
классов и прочий код уже написанный в предоставляемом проекте **изменять/удалять не нужно, необходимо их доработать**.
|
||||
Добавлять свои дополнительные классы в проект можно.
|
||||
|
||||
Создание таблиц в БД и предзаполнение их требуемыми данными уже реализовано в заготовке при помощи liquibase.
|
||||
|
||||
## 🌐 Где необходимо разместить сервер
|
||||
|
||||
Серверное приложение должно быть разработано и протестировано локально (не требуется размещать сервер удаленно и
|
||||
осуществлять его функционирование 24/7).
|
||||
|
||||
## 📋 Технические требования к серверу и его ответам клиенту
|
||||
|
||||
Для конфигурирования Вашего сервера (его хоста/IP адреса) используйте константы из файла `Constants.kt`.
|
||||
|
||||
| **Тип запроса** | **Путь** | **Параметры/Тело** | **Ответы** |
|
||||
|-----------------|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **GET** | `api/<LOGIN>/auth` | `<LOGIN>` - никнейм/имя пользователя | `400` - что-то пошло не так<br>`401` - логина не существует или неверный<br>`200` - данный логин существует - можно пользоваться приложением |
|
||||
| **GET** | `api/<LOGIN>/info` | `<LOGIN>` - никнейм/имя пользователя | `400` - что-то пошло не так<br>`401` - логина не существует или неверный<br>`200` - ОК<br>{<br> "id": 1,<br> "login": "pivanov",<br> "name": "Иванов Петр Федорович",<br> "photo": "https://funnyducks.ru/upload/iblock/0cd/0cdeb7ec3ed6fddda0f90fccee05557d.jpg",<br> "position": "Разработчик",<br> "lastVisit": "2024-02-12T08:30:00"<br>} |
|
||||
| **PATCH** | `api/<LOGIN>/open` | `<LOGIN>` - никнейм/имя пользователя<br>Тело: `{“value”: <CODE>}`, где <br> `<CODE>` - это код, полученный из экрана сканирования QR кода | `400` - что-то пошло не так<br>`401` - логина не существует или неверный<br>`200` - дверь открылась |
|
||||
|
||||
## 📊 Данные, которыми необходимо наполнить базу данных:
|
||||
|
||||
| **id** | **login** | **name** | **photo** | **position** | **lastVisit** |
|
||||
|--------|-----------|------------------------------|------------------------------------------------------------------------------|--------------|---------------------|
|
||||
| 1 | pivanov | Иванов Петр Федорович | https://funnyducks.ru/upload/iblock/0cd/0cdeb7ec3ed6fddda0f90fccee05557d.jpg | Разработчик | 2024-02-12T08:30:00 |
|
||||
| 2 | ipetrov | Петров Иван Константинович | https://funnyducks.ru/upload/iblock/0cd/0cdeb7ec3ed6fddda0f90fccee05557d.jpg | Аналитик | 2024-02-30T08:35:00 |
|
||||
| 3 | asemenov | Семенов Анатолий Анатольевич | https://funnyducks.ru/upload/iblock/0cd/0cdeb7ec3ed6fddda0f90fccee05557d.jpg | Разработчик | 2024-02-31T08:31:00 |
|
||||
| 4 | afedorov | Федоров Александр Сергеевич | https://funnyducks.ru/upload/iblock/0cd/0cdeb7ec3ed6fddda0f90fccee05557d.jpg | Тестировщик | 2024-02-30T08:36:00 |
|
||||
|
||||
| **id** | **code** |
|
||||
|--------|---------------------|
|
||||
| 1 | 1234567890123456789 |
|
||||
| 2 | 9223372036854775807 |
|
||||
| 3 | 1122334455667788990 |
|
||||
| 4 | 998877665544332211 |
|
||||
| 5 | 5566778899001122334 |
|
||||
|
||||
## 📝 Решение
|
||||
|
||||
Необходимо загрузить свое решение в систему [по ссылке](https://innovationcampus.ru/lms/mod/quiz/view.php?id=2078).
|
||||
|
||||
Отметим, что работу необходимо осуществлять в представленных проектах-заготовках (шаблонах).
|
||||
|
||||
## ✅ Особенности оценивания
|
||||
|
||||
Оценивание происходит с помощью автоматической системы тестирования, которая в автоматическом режиме находит элементы и
|
||||
взаимодействует с ними (именно для этого у каждого элемента указан уникальный идентификатор, по которому будет
|
||||
производится поиск). Каждый тест происходит с чистой установки приложения. В случае тестирования сервера на него
|
||||
поочередно отправляются команды, описанные в API и ожидаются определенные корректные ответы. Сервер и приложение
|
||||
тестируются независимо.
|
||||
11
src/main/java/com/example/nto/App.java
Normal file
11
src/main/java/com/example/nto/App.java
Normal file
@ -0,0 +1,11 @@
|
||||
package com.example.nto;
|
||||
|
||||
import org.springframework.boot.SpringApplication;
|
||||
import org.springframework.boot.autoconfigure.SpringBootApplication;
|
||||
|
||||
@SpringBootApplication
|
||||
public class App {
|
||||
public static void main(String[] args) {
|
||||
SpringApplication.run(App.class, args);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,98 @@
|
||||
package com.example.nto.controller;
|
||||
|
||||
import com.example.nto.entity.Employee;
|
||||
import com.example.nto.repository.CodeRepository;
|
||||
import com.example.nto.repository.EmployeeRepository;
|
||||
import com.example.nto.service.EmployeeService;
|
||||
import com.fasterxml.jackson.annotation.JsonProperty;
|
||||
import lombok.Getter;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.springframework.http.ResponseEntity;
|
||||
import org.springframework.web.bind.annotation.*;
|
||||
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.Map;
|
||||
|
||||
|
||||
@RestController
|
||||
@RequestMapping("/api")
|
||||
public class EmployeeController {
|
||||
private final EmployeeService employeeService;
|
||||
private final EmployeeRepository employeeRepository;
|
||||
private final CodeRepository codeRepository;
|
||||
|
||||
@Autowired
|
||||
public EmployeeController(EmployeeService employeeService, EmployeeRepository employeeRepository, CodeRepository codeRepository) {
|
||||
this.employeeService = employeeService;
|
||||
this.employeeRepository = employeeRepository;
|
||||
this.codeRepository = codeRepository;
|
||||
}
|
||||
|
||||
@Getter
|
||||
public static class UserData {
|
||||
@JsonProperty("value")
|
||||
private String value;
|
||||
}
|
||||
|
||||
@GetMapping("/{login}/auth")
|
||||
public ResponseEntity<String> authEmployee(@PathVariable String login) {
|
||||
try {
|
||||
boolean loginExists = employeeService.checkLogin(login);
|
||||
|
||||
if (loginExists) {
|
||||
return ResponseEntity.ok("данный логин существует");
|
||||
} else {
|
||||
return ResponseEntity.status(HttpStatus.UNAUTHORIZED).body("логина не существует или неверный");
|
||||
}
|
||||
} catch (Exception e) {
|
||||
return ResponseEntity.status(HttpStatus.BAD_REQUEST).body("что-то пошло не так");
|
||||
}
|
||||
}
|
||||
|
||||
@GetMapping("/{login}/info")
|
||||
public ResponseEntity<?> infoEmployee(@PathVariable String login) {
|
||||
try {
|
||||
Employee user = employeeRepository.getEmployeeByLogin(login);
|
||||
if (user != null) {
|
||||
Map<String, Object> response = new LinkedHashMap<>();
|
||||
response.put("id", user.getId());
|
||||
response.put("login", user.getLogin());
|
||||
response.put("name", user.getName());
|
||||
response.put("photo", user.getPhoto());
|
||||
response.put("position", user.getPosition());
|
||||
response.put("lastVisit", user.getLastVisit());
|
||||
|
||||
return ResponseEntity.ok(response);
|
||||
} else {
|
||||
return ResponseEntity.status(HttpStatus.UNAUTHORIZED)
|
||||
.body("логина не существует или неверный");
|
||||
}
|
||||
} catch (Exception e) {
|
||||
return ResponseEntity.status(HttpStatus.BAD_REQUEST)
|
||||
.body("что-то пошло не так");
|
||||
}
|
||||
}
|
||||
|
||||
@PatchMapping("/{login}/open")
|
||||
public ResponseEntity<?> openEmployee(@PathVariable String login, @RequestBody UserData userData) {
|
||||
try {
|
||||
long code = Long.parseLong(userData.getValue());
|
||||
boolean loginExists = employeeService.checkLogin(login);
|
||||
|
||||
if (loginExists) {
|
||||
boolean codeExists = codeRepository.checkCode(code);
|
||||
|
||||
if (codeExists) {
|
||||
return ResponseEntity.ok("дверь открылась");
|
||||
} else {
|
||||
return ResponseEntity.status(HttpStatus.BAD_REQUEST).body("что-то пошло не так");
|
||||
}
|
||||
} else {
|
||||
return ResponseEntity.status(HttpStatus.UNAUTHORIZED).body("логина не существует или неверный");
|
||||
}
|
||||
} catch (Exception e) {
|
||||
return ResponseEntity.status(HttpStatus.BAD_REQUEST).body("что-то пошло не так");
|
||||
}
|
||||
}
|
||||
}
|
||||
19
src/main/java/com/example/nto/entity/Code.java
Normal file
19
src/main/java/com/example/nto/entity/Code.java
Normal file
@ -0,0 +1,19 @@
|
||||
package com.example.nto.entity;
|
||||
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Builder;
|
||||
import lombok.Data;
|
||||
import lombok.NoArgsConstructor;
|
||||
|
||||
import javax.persistence.*;
|
||||
|
||||
@Data
|
||||
@Entity
|
||||
@Table(name = "code")
|
||||
public class Code {
|
||||
@Id
|
||||
@GeneratedValue(strategy = GenerationType.IDENTITY)
|
||||
private long id;
|
||||
|
||||
private long value;
|
||||
}
|
||||
41
src/main/java/com/example/nto/entity/Employee.java
Normal file
41
src/main/java/com/example/nto/entity/Employee.java
Normal file
@ -0,0 +1,41 @@
|
||||
package com.example.nto.entity;
|
||||
|
||||
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
|
||||
import lombok.*;
|
||||
|
||||
import javax.persistence.*;
|
||||
import java.time.LocalDateTime;
|
||||
@Data
|
||||
@Entity
|
||||
@Table(name = "employee")
|
||||
|
||||
|
||||
@JsonPropertyOrder({"id", "login", "name", "photo", "position", "lastVisit"})
|
||||
public class Employee {
|
||||
@Id
|
||||
@GeneratedValue(strategy = GenerationType.IDENTITY)
|
||||
private long id;
|
||||
|
||||
@Getter
|
||||
@Column(nullable = false, unique = true)
|
||||
private String login;
|
||||
|
||||
@Getter
|
||||
@Column(nullable = false)
|
||||
private String name;
|
||||
|
||||
@Getter
|
||||
@Column(nullable = false)
|
||||
private String photo;
|
||||
|
||||
@Getter
|
||||
@Column(nullable = false)
|
||||
private String position;
|
||||
|
||||
@Getter
|
||||
@Column(name = "last_visit", nullable = false)
|
||||
private LocalDateTime lastVisit;
|
||||
|
||||
public Long getId() { return id; }
|
||||
|
||||
}
|
||||
10
src/main/java/com/example/nto/repository/CodeRepository.java
Normal file
10
src/main/java/com/example/nto/repository/CodeRepository.java
Normal file
@ -0,0 +1,10 @@
|
||||
package com.example.nto.repository;
|
||||
|
||||
import com.example.nto.entity.Code;
|
||||
import org.springframework.data.jpa.repository.JpaRepository;
|
||||
import org.springframework.data.jpa.repository.Query;
|
||||
|
||||
public interface CodeRepository extends JpaRepository<Code, Long> {
|
||||
@Query("SELECT CASE WHEN COUNT(c) > 0 THEN TRUE ELSE FALSE END FROM Code c WHERE c.value = :value")
|
||||
boolean checkCode(long value);
|
||||
}
|
||||
@ -0,0 +1,10 @@
|
||||
package com.example.nto.repository;
|
||||
|
||||
import com.example.nto.entity.Employee;
|
||||
import org.springframework.data.jpa.repository.JpaRepository;
|
||||
|
||||
|
||||
public interface EmployeeRepository extends JpaRepository<Employee, Long> {
|
||||
Boolean existsByLogin(String login);
|
||||
Employee getEmployeeByLogin(String login);
|
||||
}
|
||||
@ -0,0 +1,5 @@
|
||||
package com.example.nto.service;
|
||||
|
||||
public interface EmployeeService {
|
||||
boolean checkLogin(String login);
|
||||
}
|
||||
@ -0,0 +1,19 @@
|
||||
package com.example.nto.service.impl;
|
||||
|
||||
import com.example.nto.service.EmployeeService;
|
||||
import com.example.nto.repository.EmployeeRepository;
|
||||
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import org.springframework.stereotype.Service;
|
||||
|
||||
@Service
|
||||
@RequiredArgsConstructor
|
||||
public class EmployeeServiceImpl implements EmployeeService {
|
||||
|
||||
private final EmployeeRepository employeeRepository;
|
||||
|
||||
@Override
|
||||
public boolean checkLogin(String login) {
|
||||
return employeeRepository.existsByLogin(login);
|
||||
}
|
||||
}
|
||||
28
src/main/resources/application.yml
Normal file
28
src/main/resources/application.yml
Normal file
@ -0,0 +1,28 @@
|
||||
spring:
|
||||
|
||||
datasource:
|
||||
url: jdbc:h2:mem:testdb
|
||||
|
||||
h2:
|
||||
console:
|
||||
#enabled: false
|
||||
enabled: true
|
||||
|
||||
jpa:
|
||||
#generate-ddl: false
|
||||
generate-ddl: true
|
||||
|
||||
hibernate:
|
||||
#ddl-auto: none
|
||||
ddl-auto: create-drop
|
||||
|
||||
# Показываем запросы
|
||||
show-sql: true
|
||||
|
||||
# Своевременный запуск data.sql
|
||||
defer-datasource-initialization: true
|
||||
|
||||
spring-doc:
|
||||
swagger-ui:
|
||||
path: /swagger-ui.html
|
||||
operationsSorter: method
|
||||
14
src/main/resources/data.sql
Normal file
14
src/main/resources/data.sql
Normal file
@ -0,0 +1,14 @@
|
||||
INSERT INTO employee (id, login, name, photo, position, last_visit)
|
||||
VALUES
|
||||
(1, 'pivanov', 'Иванов Петр Федорович', 'https://funnyducks.ru/upload/iblock/0cd/0cdeb7ec3ed6fddda0f90fccee05557d.jpg', 'Разработчик', '2024-02-12T08:30'),
|
||||
(2, 'ipetrov', 'Петров Иван Константинович', 'https://funnyducks.ru/upload/iblock/0cd/0cdeb7ec3ed6fddda0f90fccee05557d.jpg', 'Аналитик', '2024-02-13T08:35'),
|
||||
(3, 'asemenov', 'Семенов Анатолий Анатольевич', 'https://funnyducks.ru/upload/iblock/0cd/0cdeb7ec3ed6fddda0f90fccee05557d.jpg', 'Разработчик', '2024-02-13T08:31'),
|
||||
(4, 'afedorov', 'Федоров Александр Сергеевич', 'https://funnyducks.ru/upload/iblock/0cd/0cdeb7ec3ed6fddda0f90fccee05557d.jpg', 'Тестировщик', '2024-02-12T08:36');
|
||||
|
||||
INSERT INTO code (value)
|
||||
VALUES
|
||||
(1234567890123456789),
|
||||
(9223372036854775807),
|
||||
(1122334455667788990),
|
||||
(998877665544332211),
|
||||
(5566778899001122334);
|
||||
Loading…
x
Reference in New Issue
Block a user