Lembaran Cheat Spring Boot

Lembaran Cheat Spring Boot

Anotasi

Annotation	Description	Example
@SpringBootApplication	Marks a class as a Spring Boot application. Enables auto-configuration and component scanning.	@SpringBootApplication
@RestController	Indicates that a class provides RESTful endpoints. It combines @Controller and @ResponseBody annotations.	@RestController
@RequestMapping	Maps HTTP requests to handler methods of RESTful controllers.	@RequestMapping("/api")
@Autowired	Injects dependencies into a Spring bean. It can be used for constructor, setter, or field injection.	@Autowired private MyService myService;
@Component	Indicates that a class is a Spring-managed component. It is automatically detected during component scanning.	@Component
@Repository	Marks a class as a Spring Data repository. It handles data access and persistence logic.	@Repository
@Service	Marks a class as a service component in the business layer. It is used to separate business logic from presentation logic.	@Service
@Configuration	Indicates that a class provides bean definitions. It is used along with @bean to define beans in Java-based configuration.	@Configuration
@Value	Injects values from properties files or environment variables into Spring beans.	@Value("${my.property}") private String property;

Aliran Kawalan

1. Permulaan: Spring Boot bermula dengan memuatkan sifat aplikasi dan autokonfigurasi kacang.
2. Pengimbasan Komponen: Spring mengimbas untuk komponen seperti pengawal, perkhidmatan dan repositori.
3. Penciptaan Kacang: Spring mencipta kacang dan menyelesaikan kebergantungan menggunakan suntikan kebergantungan.
4. Pengendalian Permintaan: Permintaan HTTP masuk dipetakan kepada kaedah pengawal berdasarkan pemetaan permintaan.
5. Pelaksanaan: Kaedah pengawal mengendalikan permintaan, berinteraksi dengan perkhidmatan dan membalas respons.
6. Rendering Respons: Spring menukarkan nilai pulangan kaedah kepada respons HTTP yang sesuai (cth., JSON).

Struktur Folder yang Disyorkan

src
├── utama
│ ├── java
│ │ └── com
│ │ └── contoh
│ │ ├── pengawal
│ │ │ └── MyController.java
│ │ ├── perkhidmatan
│ │ │ └── MyService.java
│ │ └── Application.java
│ └── sumber
│ ├── application.properties
│ └── templat
│ └── index.html
└── ujian
└── java
└── com
└── contoh
└── pengawal
└── MyControllerTest.java

Pengendalian Ralat dalam Helaian Curang Spring Boot

Pengendalian ralat ialah aspek kritikal dalam membina aplikasi yang mantap. Spring Boot menyediakan beberapa mekanisme untuk mengendalikan ralat dan pengecualian dengan anggun, memastikan pengalaman pengguna yang lancar.

Jenis Ralat

• Ralat Pelanggan: Ralat yang disebabkan oleh permintaan pelanggan yang tidak sah, seperti 400 Bad Request atau 404 Not Found.
• Ralat Pelayan: Ralat berlaku pada bahagian pelayan, seperti Ralat Pelayan Dalaman 500.
• Ralat Pengesahan: Ralat disebabkan kegagalan input atau pengesahan data yang tidak sah.

Mekanisme Pengendalian Ralat

1. Nasihat Pengawal

• @ControllerAdvice: Anotasi yang digunakan untuk menentukan pengendali pengecualian global dalam Spring MVC.
• @ExceptionHandler: Anotasi yang digunakan untuk mengendalikan pengecualian khusus dalam nasihat pengawal.
• Contoh:

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MyException.class)
    public ResponseEntity<ErrorResponse> handleMyException(MyException ex) {
        ErrorResponse response = new ErrorResponse("My error message");
        return new ResponseEntity<>(response, HttpStatus.BAD_REQUEST);
    }

    @ExceptionHandler(Exception.class)
    public ResponseEntity<ErrorResponse> handleException(Exception ex) {
        ErrorResponse response = new ErrorResponse("Internal server error");
        return new ResponseEntity<>(response, HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

ResponseEntityExceptionHandler

• ResponseEntityExceptionHandler: Kelas asas untuk mengendalikan pengecualian MVC Spring biasa.
• Timpa: Gantikan kaedah seperti handleMethodArgumentNotValid, handleHttpMessageNotReadable, dsb.
• Contoh:

@ControllerAdvice
public class CustomExceptionHandler extends ResponseEntityExceptionHandler {

@Override
protected ResponseEntity<Object> handleMethodArgumentNotValid(
        MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
    ErrorResponse response = new ErrorResponse("Validation failed");
    return new ResponseEntity<>(response, HttpStatus.BAD_REQUEST);
}

// Other overrides for handling specific exceptions

3. Atribut Ralat

• ErrorAttributes: Antara muka yang digunakan untuk menyesuaikan kandungan dan format respons ralat.
• DefaultErrorAttributes: Pelaksanaan lalai disediakan oleh Spring Boot.

@Component
public class CustomErrorAttributes extends DefaultErrorAttributes {
@Override
public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
    Map<String, Object> errorAttributes = super.getErrorAttributes(webRequest, includeStackTrace);
    errorAttributes.put("customAttribute", "Custom value");
    return errorAttributes;
}

}

Menggunakan Fail Sifat

• application.properties: Simpan sifat seluruh aplikasi seperti port pelayan, URL pangkalan data, dll.
• Fail Sifat Tersuai: Tentukan fail sifat tersuai untuk persekitaran yang berbeza (cth., application-dev.properties).
• Mengakses Sifat: Akses sifat menggunakan anotasi @Value atau Spring's Environment API.

Projek Bangunan

• Maven: Jalankan pemasangan bersih mvn untuk membina projek dan menjana JAR boleh laku.
• Gradle: Jalankan ./gradlew build untuk membina projek dan menjana JAR boleh laku.

Topik Tambahan

• Permulaan But Musim Bunga: Gunakan pemula untuk menambah kebergantungan dan konfigurasi automatik pada projek anda.
• Log: Konfigurasikan pengelogan menggunakan Logback, Log4j atau Java Util Logging.
• Pengendalian Ralat: Laksanakan pengendalian pengecualian global dengan @ControllerAdvice.
• Pengujian: Tulis ujian unit dan ujian integrasi menggunakan JUnit, Mockito dan SpringBootTest.

Atas ialah kandungan terperinci Lembaran Cheat Spring Boot. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!