-
Notifications
You must be signed in to change notification settings - Fork 2
/
03-backend.html
610 lines (463 loc) · 15.6 KB
/
03-backend.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">
<title>Projekt i implementacja systemów webowych - wykład 3</title>
<link rel="stylesheet" href="dist/reset.css">
<link rel="stylesheet" href="dist/reveal.css">
<!-- <link rel="stylesheet" href="dist/theme/night.css"> -->
<link rel="stylesheet" href="dist/theme/white.css">
<!-- Theme used for syntax highlighted code -->
<link rel="stylesheet" href="plugin/highlight/monokai.css" id="highlight-theme">
<link rel="stylesheet" href="css/custom.css">
</head>
<body>
<div class="reveal">
<div class="slides">
<section data-markdown data-separator-vertical="^--$">
<script type="text/template">
## Projekt i implementacja systemów webowych
### Wykład 3: backendy systemów webowych
mgr inż. Maciej Małecki
---
## Agenda
1. Architektura back-endów
2. Spring oraz SpringBoot
3. Interfejsy RESTful
4. Brokery wiadomości
5. Narzędzia automatyzacji budowania oprogramowania
---
# Co to jest architektura?
--
https://martinfowler.com/bliki/DesignStaminaHypothesis.html
--
Architektura w inżynierii oprogramowania to narzędzie pozwalające na <mark>zarządzanie kosztem wprowadzania zmian</mark> w systemie.
--
Dobrze dobrana architektura pozwala na <mark>stały</mark> koszt wprowadzania zmian w czasie.
---
## Podstawowe reguły architektoniczne
--
## Separacja pojęć
_ang. separation of concerns_
--
## Minimalizacja zależności
_ang. minimize dependencies_
--
## Ukrywanie informacji
_ang. information hiding_
--
## Jednolitość
_ang. homogeneity_
Stosuj podobne metody to rozwiązywania podobnych problemów.
--
## Nie powtarzaj się
_ang. don't repeat yourself (DRY)_
--
YAGNI <!-- .element class="r-fit-text"-->
_ang. you aren't gonna need it_ <!-- .element class="fragment"-->
---
## Architektura w skali makro
--
## Modularny monolit
--
## Modularny monolit
* ✔ szybki start
* ✔ prosty deployment
* ✔ prosty monitoring
* ✘ złożoność rośnie w czasie
* ✘ kosztowny w migracji technicznej
* ✘ IDE "klęka"
--
## Mikroserwisy
--
## Mikroserwisy
* ✘ skomplikowany deployment
* ✘ skomplikowany monitoring
* ✔ łatwa migracja techniczna (dziel i rządź)
* ✔ łatwa rozbudowa
* ✔ łatwiej opanować zależności
--
### Architektura "event driven"
--
## Architektura "event driven"
* _event_ - przeszłość
* _query_ - teraźniejszość
* _command_ - przyszłość
--
## Architektura "event driven"
* ✔ "loose coupling"
* ✔ dobra skalowalność
* ✘ mniejsza przejrzystość
* ✘ asynchroniczność (jest to trudne)
---
## Architektura w skali mikro
--
## Architektura warstwowa
--
### Architektura portów i adapterów
--
### Architektura portów i adapterów
--
## Różnice
---
### Spring i SpringBoot
--
### Spring - podstawowe cechy
* Wysoka testowalność
* Redukcja nadmiarowego kodu
* IoC/DI - inversion of control/Dependency injection
* Modularność
--
### SpringBoot
* Automatyczne konfiguracja
* Konwencyjność
* Niezależność od serwerów aplikacji
* Wszystkie funkcje Springa startowane są z funkcji `main`
--
### Dependency injection
```java[|3-10|12-15]
@Service
class OrderService {
private final OrderRepository orderRepository;
private final NotificationService notificationService;
public OrderService(OrderRepository orderRepository,
NotificationService notificationService) {
this.orderRepository = orderRepository;
this.notificationService = notificationService;
}
public void saveOrder(Order order) {
orderRepository.save(order);
notificationService.notify(order.getId());
}
}
```
--
### Autowiring
```java[|1-4|6-14|6|7|8|]
interface OrderRepository extends JpaRepository<Order, Long> {}
@Service
class NotificationService {}
@EnableJpaRepositories(basePackages = {"com.foo.bar.orders.*"})
@EntityScan("com.foo.bar.orders.*")
@SpringBootApplication(scanBasePackages = {"com.foo.bar.orders"})
public class WebApiApplication {
public static void main(String[] args) {
SpringApplication.run(WebApiApplication.class, args);
}
}
```
--
### Manual wiring
```java[|1|11-14|3-5|7-9]
@Configuration
class OrderConfiguration {
@Bean OrderRepository orderRepository() {
return new OrderRepository();
}
@Bean NotificationService notificationService() {
return new NotificationService();
}
@Bean OrderService orderService(OrderRepository orderRepository,
NotificationService notificationService) {
return new OrderService(orderRepository, notificationService);
}
}
```
--
### Stary styl programowania
```java[|3-10|12-15]
@Service
class OrderService {
@Autowired
private OrderRepository orderRepository;
@Autowired
private NotificationService notificationService;
// ...
}
```
...odradzam
--
### Testowanie z użyciem Junit 5 i Mockito
```java[|1|4-7|8-9|11-20]
@ExtendWith(MockitoExtension.class)
class OrderServiceTest {
@Mock
private OrderRepository orderRepository;
@Mock
private NotificationService notificationService;
@InjectMocks
private OrderService orderService;
@Test
void shouldSaveOrder() {
// given
var order = new Order(15);
// when
orderService.saveOrder(order);
// then
verify(orderRepository).save(order);
verify(notificationService).notify(order.getId());
}
}
```
--
### SpringBoot - konfiguracja
```yaml[|2-6|7-16|17-24|25-30]
spring:
security:
oauth2:
resourceserver:
jwt:
issuer-uri: https://some.url.com/oauth
jpa:
database: postgresql
show-sql: true
properties:
hibernate.cache.use_second_level_cache: false
hibernate.cache.use_query_cache: false
hibernate.generate_statistics: false
hibernate.default_schema: ${DB_SCHEMA_NAME}
hibernate:
ddl-auto: validate
datasource:
type: com.zaxxer.hikari.HikariDataSource
hikari:
transaction-isolation: TRANSACTION_READ_COMMITTED
url: ${DB_URL}?currentSchema=${DB_SCHEMA_NAME}
username: ${DB_USER}
password: ${DB_PW}
driverClassName: org.postgresql.Driver
liquibase:
change-log: classpath:db/changelog/root.yaml
parameters:
db-schema-name: ${DB_SCHEMA_NAME}
enabled: true
label-filter: "!test-data"
```
--
### SpringBoot profile
Profile wprowadzają wariantowość (uszczegółowienie) konfiguracji dla konkretnych środowisk docelowych.
```[]
application.yaml
application-dev.yaml
application-test.yaml
application-prod.yaml
```
```yaml[]
spring:
jpa:
show-sql: false
```
---
## Interfejsy RESTful
<mark>REST</mark> = Representational State Transfer
<mark>HATEOS</mark> = Hypermedia as the Engine of Application State
--
## Anatomia REST
--
### Metody HTTP - operacje REST
* GET - pobranie zasobu
* POST - utworzenie zasobu
* PUT - zastąpienie zasobu
* PATCH - modyfikacja zasobu
* DELETE - usunięcie zasobu
* OPTIONS - zapytanie o możliwe metody
--
### Spring MVC
```java[|1|2|5-8|10-13|15-18|20-23|25-28]
@RestController
@RequestMapping("/api/orders")
class OrderController {
@GetMapping
ResponseEntity<List<Order>> getOrders() {
// ...
}
@GetMapping("/{id}")
ResponseEntity<Order> getOrder(@PathVariable Long id) {
// ...
}
@PostMapping
ResponseEntity<Order> createOrder(@RequestBody Order order) {
// ...
}
@PutMapping("/{id}")
ResponseEntity<Order> updateOrder(@PathVariable Long id, @RequestBody Order order) {
// ...
}
@DeleteMapping("/{id}")
ResponseEntity deleteOrder(@PathVariable Long id) {
// ...
}
}
```
---
## Brokery wiadomości
ang. _message broker_
> Wyspecjalizowane narzędzia komunikacyjne, które umożliwiają przesyłanie wiadomości między różnymi systemami.
### Przykłady
* Apache Kafka
* RabbitMQ
* MQTT
--
## Cechy
* <mark>Asynchroniczność</mark> - pozwala wstawić komunikat do kolejki, bez blokowania wątku.
* <mark>Skalowalność</mark> - dzięki asynchroniczności.
* <mark>Separacja</mark> - nadawcy i odbiorcy nie muszą o sobie wiedzieć.
* <mark>Rozszerzalność</mark> - dodajemy dodatkowych "konsumentów" bez wpływu na resztę systemu.
--
### Kafka & Spring KafkaTemplate
Producent:
```java[|4|8-12|14-24]
@AllArgsConstructor
class NotifyOnDataAdapter {
private final KafkaTemplate<String, String> kafkaTemplate;
private final String topicNamespace;
private final String topicSuffix;
public void notify(List<Data> data) {
final var topicName = topicNamespace + "." + topicSuffix;
data.stream().map(PayloadMapper.INSTANCE::toPayload).forEach(payload ->
sendRecord(topicName, payload));
}
private void sendRecord(String topicName, Payload payload) {
try {
var objectMapper = new ObjectMapper();
objectMapper.findAndRegisterModules();
var serializedData = objectMapper.writeValueAsString(payload);
var producerRecord = new ProducerRecord<String, String>(topicName, serializedData);
kafkaTemplate.send(producerRecord);
} catch (JsonProcessingException e) {
throw new RuntimeException(e);
}
}
}
```
--
### Kafka & Spring KafkaTemplate
Konsument:
```java[]
@Slf4j
class DataListener {
@KafkaListener(topics = "com.foo.data.topic.v1")
public void listen(Message<String> message) {
log.info("Event received: {}.", message.getPayload());
}
}
```
---
## Automatyzacja budowania oprogramowania
--
> Celem narzędzi automatyzujących jest budowanie oprogramowania wraz z jego testowaniem, pakowaniem, walidacją, a często i instalacją na środowisku docelowym.
--
### Podstawowe cechy obu narzędzi
* Zarządzanie zależnościami zewnętrznymi.
* Zarządzanie zależnościami wewnętrznymi (modularyzacja).
* Konwencyjność.
* Uruchamianie testów.
* Rozszerzalność poprzez system pluginów.
--
### Maven
* Bazuje na XML.
* Definiuje system faz budowania.
* Pliki `pom.xml` (project object model) określają co, a nie jak.
--
### Gradle
* Bazuje na Groovy lub Kotlinie.
* Definiuje system tasków.
* Pliki `build.gradle` określają zarówno "co" ale pozwalają na zdefiniowanie "jak" (skrypty).
* Zadania jak i pluginy można zdefiniować "ad hoc" w pliku `build.gradle`.
--
### Gradle - przykład
```kotlin[|9-13|17|21-30|40-50|51-58]
val springBootVersion: String by project
val lombokVersion: String by project
val junitVersion: String by project
val assertJVersion: String by project
val archunitVersion: String by project
val mockitoVersion: String by project
val slf4jVersion: String by project
plugins {
id("java-library")
id("com.diffplug.spotless")
id("jacoco")
}
java {
toolchain {
languageVersion.set(JavaLanguageVersion.of(17))
}
}
spotless {
isEnforceCheck = true
java {
importOrder()
palantirJavaFormat()
removeUnusedImports()
formatAnnotations()
targetExclude("**/generated/**")
}
}
tasks.withType<Test> {
useJUnitPlatform()
}
repositories {
mavenCentral()
}
dependencies {
// Slf4J
compileOnly("org.slf4j:slf4j-api:$slf4jVersion")
// lombok
compileOnly("org.projectlombok:lombok:$lombokVersion")
annotationProcessor("org.projectlombok:lombok:$lombokVersion")
testCompileOnly("org.projectlombok:lombok:$lombokVersion")
testAnnotationProcessor("org.projectlombok:lombok:$lombokVersion")
// arch unit
testImplementation("com.tngtech.archunit:archunit-junit5:$archunitVersion")
// junit
testImplementation("org.junit.jupiter:junit-jupiter-api:$junitVersion")
testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:$junitVersion")
testImplementation("org.assertj:assertj-core:$assertJVersion")
// mockito
testImplementation("org.mockito:mockito-junit-jupiter:$mockitoVersion")
testImplementation("org.springframework.boot:spring-boot-starter-test:$springBootVersion") {
exclude(group = "org.junit.vintage", module = "junit-vintage-engine")
}
}
```
</script>
</section>
</div>
</div>
<script src="dist/reveal.js"></script>
<script src="plugin/notes/notes.js"></script>
<script src="plugin/markdown/markdown.js"></script>
<script src="plugin/highlight/highlight.js"></script>
<script>
// More info about initialization & config:
// - https://revealjs.com/initialization/
// - https://revealjs.com/config/
Reveal.initialize({
hash: true,
width: 1200,
slideNumber: 'c/t',
// Learn about plugins: https://revealjs.com/plugins/
plugins: [ RevealMarkdown, RevealHighlight, RevealNotes ]
});
</script>
</body>
</html>