整理全部有關 Spring boot 的技術

• 可以在 spring boot App -> spring boot -> profiles 進行設定
• 可以在 spring boot App -> Enviroment -> 新增 spring.profiles.active:sit
• https://blog.csdn.net/qq_42982923/article/details/119242216

• 圖片來源：https://www.bootschool.net/ascii-art
• 切換環境：https://www.baeldung.com/spring-boot-disable-banner

• Spring Boot Scheduling Tasks
• 需要加 @EnableScheduling
• https://polinwei.com/spring-boot-scheduling-tasks/
• cron表示式定義

    ┌───────────── second (0-59)
    │ ┌───────────── minute (0 - 59)
    │ │ ┌───────────── hour (0 - 23)
    │ │ │ ┌───────────── day of the month (1 - 31)
    │ │ │ │ ┌───────────── month (1 - 12) (or JAN-DEC)
    │ │ │ │ │ ┌───────────── day of the week (0 - 7)
    │ │ │ │ │ │          (0 or 7 is Sunday, or MON-SUN)
    │ │ │ │ │ │
    * * * * * *
  

• 可出現的字元型別和各字元的含義

   秒：可出現: ”, – * /” 左列的四個字元，有效範圍為0-59的整數
   分：可出現: ”, – * /” 左列的四個字元，有效範圍為0-59的整數
   時：可出現: ”, – * /” 左列的四個字元，有效範圍為0-23的整數
   每月第幾天：可出現: ”, – * / ? L W C” 左列的八個字元，有效範圍為0-31的整數
   月：可出現: ”, – * /” 左列的四個字元，有效範圍為1-12的整數或JAN-DEc
   星期：可出現: ”, – * / ? L C #” 左列的八個字元，有效範圍為1-7的整數或SUN-SAT兩個範圍。1表示星期天，2表示星期一， 依次類
  

• 特殊字元含義

   * : 表示匹配該域的任意值，比如在秒*, 就表示每秒都會觸發事件。；
   ? : 只能用在每月第幾天和星期兩個域。表示不指定值，當2個子表示式其中之一被指定了值以後，為了避免衝突，需要將另一個子表示式的值設為“?”；
   – : 表示範圍，例如在分域使用5-20，表示從5分到20分鐘每分鐘觸發一次  
   / : 表示起始時間開始觸發，然後每隔固定時間觸發一次，例如在分域使用5/20,則意味著5分，25分，45分，分別觸發一次.  
   , : 表示列出列舉值。例如：在分域使用5,20，則意味著在5和20分時觸發一次。  
   L : 表示最後，只能出現在星期和每月第幾天域，如果在星期域使用1L,意味著在最後的一個星期日觸發。  
   W : 表示有效工作日(週一到週五),只能出現在每月第幾日域，系統將在離指定日期的最近的有效工作日觸發事件。注意一點，W的最近尋找不會跨過月份  
   LW : 這兩個字元可以連用，表示在某個月最後一個工作日，即最後一個星期五。  
   # : 用於確定每個月第幾個星期幾，只能出現在每月第幾天域。例如在1#3，表示某月的第三個星期日。
  

• 參考 SchedulingConfige 範例
• 每次執行皆自動延遲時間加 1 秒
• PeriodicTrigger fixedRate
  • Specify whether the periodic interval should be measured between the scheduled start times rather than between actual completion times.
  • TODO fixedRate true false 的差異
• TODO cron 的格式，應該與原先設定一致
• https://chikuwa-tech-study.blogspot.com/2023/03/spring-boot-scheduled-task-incl-dymanically.html

• 使用 @Configuration、＠Component
  • 預設為全部 api 皆會通過此 filter
• 使用 @WebFilter
  • 指定特定 req 才會通過此 filter
  • 需要再新增 @ServletComponentScan 在 application.java 檔

• 繼承 OncePerRequestFilter，並改寫 doFilterInternal
  • 從 HttpServletRequest 取得 httpMethod、uri、params 等參數
• 取得 request 參數
  • 由於 inputstream 只可以读取一次，需進行調整
  • 繼承 HttpServletRequestWrapper，改寫 getInputStream，使用新的 ServletInputStream 裝資料 (準備進行改寫)
  • 添加 commons-io dependency，使用 IOUtils.toByteArray 的方法
• https://chikuwa-tech-study.blogspot.com/2021/05/spring-boot-filter-request-and-response.html
• https://easyboot.xyz/posts/52559/
• https://juejin.cn/post/7024038764804735012

• 需要執行下列程式，否則會陷入 doFilter 的 loop

    ServletOutputStream outputStream = response.getOutputStream();
    outputStream.write(resbody.getBytes());
    outputStream.flush();
    outputStream.close();
  

• https://blog.51cto.com/u_15585381/5277668

• 實作 HandlerInterceptor，決定攔截器功能，並註冊為 component
• 實作 WebMvcConfigurer，註冊攔截器與攔截路徑，並註冊為 component
• https://ithelp.ithome.com.tw/articles/10278220

• 實作 ApplicationContextAware
• 待撰寫範例
• https://iter01.com/535392.html

• 可以用來查看當前的 SpringBoot 程式運行的內部狀況，譬如知道自動化配置的資訊、創建的 Spring beans 和獲取當前的 properties 屬性值
  • 開啟所有endpoints(不包含shutdown)
    • management.endpoints.web.exposure.include=*
  • 開啟/actuator/beans和/actuator/mappings
    • management.endpoints.web.exposure.include=beans,mappings
• 輸入 ./actuator/beans
• https://kucw.github.io/blog/2020/7/spring-actuator/
• 在 log 輸出部分，有紀錄

  Exposing 13 endpoint(s) beneath base path '/actuator'
  

• 在 /actuator 裏面，常見的功能有：
  • beans：查詢全部被註冊 bean 的名稱
  • envs：查詢全部的環境變數 (包含自定義)
  • mappings：查看全部的 endpoint
  • scheduledtasks： 查看目前排程狀態

• 進行改寫 spring bean 名稱
• 繼承 AnnotationBeanNameGenerator 並改寫 buildDefaultBeanName
• 在啟動程式 (xxxApplication.class)，@ComponentScan 需添加 nameGenerator 的參數

• https://www.baeldung.com/spring-boot-yaml-list
• https://www.baeldung.com/spring-value-annotation
• 預設參數清單 https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html
• yaml 轉換成 properties https://mageddo.com/tools/yaml-converter

• https://ithelp.ithome.com.tw/articles/10297778

• 參考 sample code
• https://ithelp.ithome.com.tw/articles/10250968
• 參數放在 header 進行傳送
• 在 controller 使用 @RequestHeader("Authorization") 可以取出
• 可以使用 postman Authorization ，並選擇 Bearer Token，傳輸時，會在前面加上 Bearer jwt....
  • 需要再把 Bearer 拿掉，可用字串方式拆解 authorization.substring(6)
• 在 HandlerInterceptor 中的 HttpServletRequest 型別時，可以直接使用 .getHeader("Authorization") 取出

  public class LoginCheckInterceptor implements HandlerInterceptor {
    
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
    		throws Exception{
    
    	HandlerMethod hm = (HandlerMethod) handler;
    	
    	String header = request.getHeader("Authorization");
    	
    	String token = header.substring(6);
    	
    	// .....
    }
  }	
  

• https://www.svlada.com/jwt-token-authentication-with-spring-boot/
• https://github.com/bezkoder/spring-boot-refresh-token-jwt
• https://chikuwa-tech-study.blogspot.com/2021/06/spring-boot-username-password-authentication-and-jwt.html
• 解開 jwt 方法
  • 前端回傳時，通常會帶有前綴字：bearer
  • 在解開時，需要從第七個字開始取 jwt.subString(7)
  • https://blog.csdn.net/qq_42411805/article/details/124676309
• https://ithelp.ithome.com.tw/articles/10256445
• https://www.1ju.org/article/openapi-jwt-authentication

• 將資訊儲放 session 中
• 從 HttpServletRequest 取出 session
• 內部可以擺放物件
• 登入時，存入 session ，登出時，清除 session
• 在 application 內設定參數，可以修改 cookie 的名稱
  • server.servlet.session.cookie.name=COOKIE_NAME
• https://springhow.com/customizing-spring-session-cookies/

• https://waynestalk.com/spring-boot-restful-download-image/
• https://shinyu0430.github.io/2022/05/06/springUploadImage/
• https://www.baeldung.com/java-base64-image-string
• string to img online https://codebeautify.org/base64-to-image-converter
• 新增回傳 gz 壓縮欓範例
  • 參考 sample code
  1. 使用 GZIPOutputStream 將檔案進行壓縮
  2. 重新設定 header，並設定下載檔案名稱
  3. 使用 postman 回傳時，雖然為亂碼，但回傳框的左上角，有 save as file ，則可以將檔案進行下載
  4. 比較檔案大小 (待比較)
• 新增使用 postman 上傳檔案方式
  • body 切換至 form-data
  • 針對變數設置 key value
  • key 後端可以切換為 file，將變數型別為 MultipartFile 選擇為 file，並上傳檔案

• h2 dependency 不需要使用 runtime

• 新增一個 bean port 不可以和 spring 啟動的 port 一樣

   /**
     * Start internal H2 server so we can query the DB from IDE
     *
     * @return H2 Server instance
     * @throws SQLException
     */
    @Bean(initMethod = "start", destroyMethod = "stop")
    public Server h2Server() throws SQLException {
        return Server.createTcpServer("-tcp", "-tcpAllowOthers", "-tcpPort", "9090");
    }
  

• application.yml 設定

  spring:
  h2:
    console:
      enabled: true
      path: '/h2-console-log'
  
  datasource:
    url: 'jdbc:h2:mem:local'
  

• dbeaver 使用 h2 server 連線

  • 組合資訊：bean 的 port + url h2 後面那一段
  • Host
  • jdbc:h2:tcp://localhost:9090/mem:local

• https://stackoverflow.com/questions/43256295/how-to-access-in-memory-h2-database-of-one-spring-boot-application-from-another/43276769#43276769

• controller
  • class 標註 @Tag
  • method 標註 @Operation
• 攔截器會影響到 swagger 需要額外設定 application.yml
• https://stackoverflow.com/questions/67162911/petstore-url-swagger-default-app-not-disabled-in-springdoc
• swagger 只能適用於 REST API 上
  • 需要為 ＠RestController 或是 @Controller + @ResponseBody 才會被註冊到 swagger 裏面

• spring.jpa.hibernate.ddl-auto
  • create: 啟動時建立Table, 下次啟動會覆蓋上次的, 故會造成資料遺失
  • update: 若無Table則啟動時建立, 若有則視有無變更自動Update
  • create-drop: 啟動時建立Table, 當次Session關閉則刪除 (hsqldb, h2 的 default)
  • validate: 只驗證，不修改表格
  • none: 蛤也不做 (大部分的 default)
• https://fookwood.com/hibernate-generate-ddl
• https://www.eolink.com/news/post/14975.html

• minimumIdle 是 HikariCP 在连接池中维护的最小空闲连接数
• maximumPoolSize 配置最大池大小
• idleTimeout 是允许连接在连接池中空闲的最长时间
• maxLifetime 是池中连接关闭后的最长生命周期（以毫秒为单位)
• connectionTimeout 是客户端等待连接池连接的最大毫秒数
• https://www.cnblogs.com/chaojizhengui/p/Hikari_.html

• GeneratedValue (strategy 的參數)
  • 默認：全部 table 依序往下累積數量
  • GenerationType.IDENTITY : 每個 table 從 1 開始
  • GenerationType.AUTO : 由 hibernate 自動產生, 此種方法會跨 table 共用
• jndi 與 jdbc 差異：https://cloud.tencent.com/developer/article/1455718
• jpa 依據使用的設定，決定使用哪種連線方式
  • jndi: 需要再把連線資訊寫在容器中

    spring.datasource.jndi-name=java:comp/env/jdbc/mydatabase
    

  • jdbc: 帳號密碼寫在設定檔中

    spring.datasource.url=jdbc:mysql://localhost:3306/mydatabase
    spring.datasource.username=myuser
    spring.datasource.password=mypassword
    spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
    

• @Repository: 如果在 SpringBootApplication 標註 @EnableJpaRepositories("com.***.dao") ，則可以不需要 @Repository
• https://stackoverflow.com/questions/69909613/why-spring-data-jpa-unnecessary-repository
• oneToMany
• https://stackoverflow.com/questions/27672337/detached-entity-passed-to-persist-when-save-the-child-data
• https://www.geeksforgeeks.org/how-to-implement-one-to-many-mapping-in-spring-boot/
• @Entity
  • @PrePersist: 在儲存 Entity 之前呼叫，如儲存前塞入資料建立時間

    @PrePersist
    void onCreate() {
    	this.setLogDttm(new Timestamp((new Date()).getTime()));
    }
    

  • 參考
• https://blog.csdn.net/qq_41378597/article/details/103798684

• singleton (default)
  • 預設的bean scope，整個IoC容器中只會有一個實例，又稱單例
• prototype
  • 每次被調用（注入）時都是產生新的實例。
  • 若bean有狀態(stateful)，使用 prototype bean。
  • 注意若注入的對象為 singleton bean 的成員，則該 prototype 僅在 singleton 對象初始時實例化一次，也就是說每次 singleton bean 被調用時使用的 prototype bean 都是同一個。
• request
  • Web 環境才有的 scope。
  • 實例的 scope 為 HTTP Request，同個 request 的實例為同一個，也就是不同 request 的實例是不同的
• session
  • Web 環境才有的 scope。
  • 實例的 scope 為 HTTP Session，同個 sessio n的實例為同一個，也就是不同 session 的實例是不同的。
• application
  • Web 環境才有的 scope。
  • 實例的 scope 為 ServletContext，同個 ServletContext 的實例為同一個，也就是不同 ServletContext 的實例是不同的。
• websocket
  • Web 環境才有的 scope。
  • 實例的 scope 為 WebSocket，同個 WebSocket 的實例為同一個，也就是不同 WebSocket 的實例是不同的。
• 參考
• sample code

• @Accessors
  • chain = true:
    • 原本 setter 的方法回傳 void，但標註 @Accessors(chain = true) 後，回傳為該物件本身

      @Data
      @Accessors(chain = true)
      public class EmployEntity {
      
      	private Intger id;
      }
      
      

      原本 setter id 的 method 為

      public void setId(Integer id){
      }
      

      被改寫為

      public EmployEntity setId(Integer id){
      }
      

• spring boot <= 2.1
  • 僅使用 Junit4，使用 @RunWith
• spring boot 2.2, 2.3
  • 能使用 Junit4，使用 @RunWith
  • 能使用 Junit5，使用 @ExtendWith
• spring boot >= 2.4
  • 僅使用 Junit5，使用 @ExtendWith
• https://www.shouxicto.com/article/232.html
• https://vivifish.medium.com/java-%E5%96%AE%E5%85%83%E6%B8%AC%E8%A9%A6%E5%B7%A5%E5%85%B7-mockito-e5f0ce93579d
• 覆蓋率：右鍵點選 Coverage As 或是 工具列的 Launch Employ ServiceTest
• https://dotblogs.com.tw/eric3724135/2013/12/11/133482
• mvn test report
  • 在 pom.xml 新增

    <reporting>
    	<plugins>
    		<plugin>
    			<groupId>org.apache.maven.plugins</groupId>
    			<artifactId>maven-surefire-report-plugin</artifactId>
    			<version>3.0.0-M9</version>
    		</plugin>
    	</plugins>
    </reporting>
    

  • 執行 surefire-report:report
  • A HTML report should be generated in ${basedir}/target/site/surefire-report.html
  • https://maven.apache.org/surefire/maven-surefire-report-plugin/usage.html
• Mock & spy
  • Mock 全部都是假的，都要假設回傳值
  • spy 可以為真的，也可以假設回傳值

    spy 對象實際上是一個代理對象，它包裝了一個真實的對象，同時提供了一些用於對其行為進行修改和檢查的方法。
    spy 對象通過動態代理技術實現，即當您調用 spy 對象的方法時，它會自動調用原始對象的方法，然後將其包裝在 spy 對象的方法中。
    在設置 spy 對象的行為時，它將覆蓋原始對象的行為，從而實現對對象行為的修改和檢查。
    

  • https://matthung0807.blogspot.com/2018/08/mockito-mockspy.html
  • https://javapointers.com/java/unit-test/difference-between-spy-and-mock-in-mockito/

• https://dotblogs.com.tw/chhuang/2011/01/19/20883
• https://blog.csdn.net/u010142437/article/details/17767809
• https://juejin.cn/post/7022798228492042276

• 在 pom.xml 新增 plugin 內容如下：

    <plugin>
      <groupId>org.owasp</groupId>
      <artifactId>dependency-check-maven</artifactId>
      <version>8.1.1</version>
      <executions>
          <execution>
              <goals>
                  <goal>check</goal>
              </goals>
          </execution>
      </executions>
    </plugin>
  

• 執行 mvn org.owasp:dependency-check-maven:check
• 在 target 會產生 dependency-check-report.html 的檔案
• summary 會顯示有問題的 dependency
  • 提高 dependency 的版號
  • 確認使用新的 dependency 版本後，可以繼續執行專案

• TODO待補充 (參考凱基)
• https://groups.google.com/g/jackson-user/c/iBqtXpxn7Ds

• 簡單範例
• 將資料塞入 xml 中，並印出 xml 格式
• https://www.796t.com/p/1330963.html

• jar 與 war 差異：jar只會將程式打包，不會額外包入使用到的 jar 檔
• 在 pom.xml 裏面新增 plugin

    <plugin>
    	<groupId>org.apache.maven.plugins</groupId>
    	<artifactId>maven-dependency-plugin</artifactId>
    	<executions>
    		<execution>
    			<id>copy-dependencies</id>
    			<phase>package</phase>
    			<goals>
    				<goal>copy-dependencies</goal>
    			</goals>
    			<configuration>
    				<outputDirectory>${project.build.directory}/lib</outputDirectory>
    				<overWriteReleases>false</overWriteReleases>
    				<overWriteSnapshots>false</overWriteSnapshots>
    				<overWriteIfNewer>true</overWriteIfNewer>
    			</configuration>
    		</execution>
    	</executions>
    </plugin>
  

• 執行 maven package 的時候，會在 target 產生 lib(在 plugin 有描述) folder，擺放全部使用到的 jar

• 輸出樣式

  • 在 log4j2 的 LOG_PATTERN 進行設定

• 新增輸出站位符號

  • 使用 org.apache.logging.log4j.ThreadContext 新增站位符號

    /**
     * 新增 log 欄位
     */
    private void addUuidFields(String uuid) {
    	
    	ThreadContext.put("uuid", uuid);
    	
    }
    

  • 在 LOG_PATTERN 則可以使用這一個站位符號
  • https://www.kancloud.cn/apachecn/howtodoinjava-zh/1953027

• 發送方式

  • 設定 header
  • 設定 request
  • 設定 response

  // 設定 header
  HttpHeaders headers =  new HttpHeaders();
  headers.setContentType(MediaType.APPLICATION_JSON);
  
  // 設定 request
  E2eeRequest e2eeRequest = new E2eeRequest();
  
  // 組合為請求
  HttpEntity<E2eeRequest> requestEntity = new HttpEntity<E2eeRequest>(e2eeRequest, headers);
  
  // 發送請求
  RestTemplate restTemplate = new RestTemplate();
  E2eeResponse e2eeResponse = restTemplate.postForObject(e2eUrl, requestEntity,  E2eeResponse.class);
  

• 設定 timeout

   SimpleClientHttpRequestFactory factory = new SimpleClientHttpRequestFactory();
   factory.setConnectTimeout(1000);
   factory.setReadTimeout(1000);
   
   //...
   restTemplate.setRequestFactory(factory);
   
  

  • 超過 timeout 時間時，就會拋出 exception
  • 預設沒有 timeout 時間上線

• https://stackoverflow.com/questions/11537591/resttemplate-default-timeout-value

• https://www.gushiciku.cn/pl/20Ak/zh-tw