Merge branch 'develop'

Author: carrypann

README.md

@@ -11,8 +11,11 @@
 - 提供gradle快速发布插件[devops-publish-gradle-plugin](./devops-boot-project/devops-boot-tools/devops-publish-gradle-plugin/README.md)
 - 提供统一版本依赖管理[devops-boot-dependencies](./devops-boot-project/devops-boot-dependencies/README.md)
 - 提供多个开箱即用的starter组件
-  - [logging日志组件](./devops-boot-project/devops-boot-starters/devops-boot-starter-logging/README.md)
-  - TODO
+  - [starter-logging](./devops-boot-project/devops-boot-starters/devops-boot-starter-logging/README.md)
+  - [starter-api](./devops-boot-project/devops-boot-starters/devops-boot-starter-api/README.md)
+  - [starter-web](./devops-boot-project/devops-boot-starters/devops-boot-starter-web/README.md)
+  - [starter-service](./devops-boot-project/devops-boot-starters/devops-boot-starter-service/README.md)
+  - TODO  
 
 ## 快速开始
 - **gradle.build.kts**
@@ -59,4 +62,3 @@ devops-framework/
 ## 发行版本
 - 0.0.1 2020年10月9日
 - 0.0.2 2020年12月22日
-

buildSrc/src/main/kotlin/Dependencies.kt

@@ -10,4 +10,5 @@ object Libs {
 object MavenBom {
     const val SpringBoot = "org.springframework.boot:spring-boot-dependencies:${Versions.SpringBoot}"
     const val SpringCloud = "org.springframework.cloud:spring-cloud-dependencies:${Versions.SpringCloud}"
+    const val DevOpsBoot = ":devops-boot-project:devops-boot-dependencies"
 }

devops-boot-project/devops-boot-core/build.gradle.kts

@@ -20,12 +20,12 @@ subprojects {
             mavenBom(MavenBom.SpringBoot)
             mavenBom(MavenBom.SpringCloud)
         }
+        pomCustomizationSettings.isEnabled = false
     }
 
     dependencies {
+        implementation(platform(project(MavenBom.DevOpsBoot)))
         implementation(Libs.KotlinStdLib)
-        implementation("org.springframework.boot:spring-boot-starter")
-        kapt("org.springframework.boot:spring-boot-configuration-processor")
         testImplementation("org.springframework.boot:spring-boot-starter-test") {
             exclude(group = "org.junit.vintage", module = "junit-vintage-engine")
         }
@@ -42,11 +42,5 @@ subprojects {
         test {
             useJUnitPlatform()
         }
-        jar {
-            manifest {
-                attributes("Implementation-Title" to (project.description ?: project.name))
-                attributes("Implementation-Version" to Release.Version)
-            }
-        }
     }
 }

devops-boot-project/devops-boot-core/devops-api/build.gradle.kts

@@ -0,0 +1,6 @@
+description = "DevOps Boot Api"
+
+dependencies {
+    api("io.swagger:swagger-annotations")
+    api("io.swagger:swagger-models")
+}

devops-boot-project/devops-boot-core/devops-api/src/main/kotlin/com/tencent/devops/api/http/HttpHeaders.kt

@@ -0,0 +1,63 @@
+package com.tencent.devops.api.http
+
+/**
+ * HTTP Header常量
+ */
+object HttpHeaders {
+    const val ACCEPT = "Accept"
+    const val ACCEPT_CHARSET = "Accept-Charset"
+    const val ACCEPT_ENCODING = "Accept-Encoding"
+    const val ACCEPT_LANGUAGE = "Accept-Language"
+    const val ACCEPT_RANGES = "Accept-Ranges"
+    const val AGE = "Age"
+    const val ALLOW = "Allow"
+    const val AUTHORIZATION = "Authorization"
+    const val CACHE_CONTROL = "Cache-Control"
+    const val CONNECTION = "Connection"
+    const val CONTENT_DISPOSITION = "Content-DISPOSITION"
+    const val CONTENT_ENCODING = "Content-Encoding"
+    const val CONTENT_LANGUAGE = "Content-Language"
+    const val CONTENT_LENGTH = "Content-Length"
+    const val CONTENT_LOCATION = "Content-Location"
+    const val CONTENT_MD5 = "Content-MD5"
+    const val CONTENT_RANGE = "Content-Range"
+    const val CONTENT_TYPE = "Content-Type"
+    const val DATE = "Date"
+    const val DAV = "Dav"
+    const val DEPTH = "Depth"
+    const val DESTINATION = "Destination"
+    const val ETAG = "ETag"
+    const val EXPECT = "Expect"
+    const val EXPIRES = "Expires"
+    const val FROM = "From"
+    const val HOST = "Host"
+    const val IF = "If"
+    const val IF_MATCH = "If-Match"
+    const val IF_MODIFIED_SINCE = "If-Modified-Since"
+    const val IF_NONE_MATCH = "If-None-Match"
+    const val IF_RANGE = "If-Range"
+    const val IF_UNMODIFIED_SINCE = "If-Unmodified-Since"
+    const val LAST_MODIFIED = "Last-Modified"
+    const val LOCATION = "Location"
+    const val LOCK_TOKEN = "Lock-Token"
+    const val MAX_FORWARDS = "Max-Forwards"
+    const val OVERWRITE = "Overwrite"
+    const val PRAGMA = "Pragma"
+    const val PROXY_AUTHENTICATE = "Proxy-Authenticate"
+    const val PROXY_AUTHORIZATION = "Proxy-Authorization"
+    const val RANGE = "Range"
+    const val REFERER = "Referer"
+    const val RETRY_AFTER = "Retry-After"
+    const val SERVER = "Server"
+    const val STATUS_URI = "Status-URI"
+    const val TE = "TE"
+    const val TIMEOUT = "Timeout"
+    const val TRAILER = "Trailer"
+    const val TRANSFER_ENCODING = "Transfer-Encoding"
+    const val UPGRADE = "Upgrade"
+    const val USER_AGENT = "User-Agent"
+    const val VARY = "Vary"
+    const val VIA = "Via"
+    const val WARNING = "Warning"
+    const val WWW_AUTHENTICATE = "WWW-Authenticate"
+}

devops-boot-project/devops-boot-core/devops-api/src/main/kotlin/com/tencent/devops/api/http/HttpStatus.kt

@@ -0,0 +1,102 @@
+package com.tencent.devops.api.http
+
+/**
+ * HTTP 状态码枚举类
+ */
+enum class HttpStatus(
+    val code: Int,
+    val reasonPhrase: String
+) {
+    CONTINUE(100, "Continue"),
+    SWITCHING_PROTOCOLS(101, "Switching Protocols"),
+    PROCESSING(102, "Processing"),
+    CHECKPOINT(103, "Checkpoint"),
+    OK(200, "OK"),
+    CREATED(201, "Created"),
+    ACCEPTED(202, "Accepted"),
+    NON_AUTHORITATIVE_INFORMATION(203, "Non-Authoritative Information"),
+    NO_CONTENT(204, "No Content"),
+    RESET_CONTENT(205, "Reset Content"),
+    PARTIAL_CONTENT(206, "Partial Content"),
+    MULTI_STATUS(207, "Multi-Status"),
+    ALREADY_REPORTED(208, "Already Reported"),
+    IM_USED(226, "IM Used"), // 3xx Redirection
+    MULTIPLE_CHOICES(300, "Multiple Choices"),
+    MOVED_PERMANENTLY(301, "Moved Permanently"),
+    FOUND(302, "Found"),
+    MOVED_TEMPORARILY(302, "Moved Temporarily"),
+    SEE_OTHER(303, "See Other"),
+    NOT_MODIFIED(304, "Not Modified"),
+    USE_PROXY(305, "Use Proxy"),
+    TEMPORARY_REDIRECT(307, "Temporary Redirect"),
+    PERMANENT_REDIRECT(308, "Permanent Redirect"), // --- 4xx Client Error ---
+    BAD_REQUEST(400, "Bad Request"),
+    UNAUTHORIZED(401, "Unauthorized"),
+    PAYMENT_REQUIRED(402, "Payment Required"),
+    FORBIDDEN(403, "Forbidden"),
+    NOT_FOUND(404, "Not Found"),
+    METHOD_NOT_ALLOWED(405, "Method Not Allowed"),
+    NOT_ACCEPTABLE(406, "Not Acceptable"),
+    PROXY_AUTHENTICATION_REQUIRED(407, "Proxy Authentication Required"),
+    REQUEST_TIMEOUT(408, "Request Timeout"),
+    CONFLICT(409, "Conflict"),
+    GONE(410, "Gone"),
+    LENGTH_REQUIRED(411, "Length Required"),
+    PRECONDITION_FAILED(412, "Precondition Failed"),
+    PAYLOAD_TOO_LARGE(413, "Payload Too Large"),
+    REQUEST_ENTITY_TOO_LARGE(413, "Request Entity Too Large"),
+    URI_TOO_LONG(414, "URI Too Long"),
+    REQUEST_URI_TOO_LONG(414, "Request-URI Too Long"),
+    UNSUPPORTED_MEDIA_TYPE(415, "Unsupported Media Type"),
+    REQUESTED_RANGE_NOT_SATISFIABLE(416, "Requested range not satisfiable"),
+    EXPECTATION_FAILED(417, "Expectation Failed"),
+    I_AM_A_TEAPOT(418, "I'm a teapot"),
+    INSUFFICIENT_SPACE_ON_RESOURCE(419, "Insufficient Space On Resource"),
+    METHOD_FAILURE(420, "Method Failure"),
+    DESTINATION_LOCKED(421, "Destination Locked"),
+    UNPROCESSABLE_ENTITY(422, "Unprocessable Entity"),
+    LOCKED(423, "Locked"),
+    FAILED_DEPENDENCY(424, "Failed Dependency"),
+    TOO_EARLY(425, "Too Early"),
+    UPGRADE_REQUIRED(426, "Upgrade Required"),
+    PRECONDITION_REQUIRED(428, "Precondition Required"),
+    TOO_MANY_REQUESTS(429, "Too Many Requests"),
+    REQUEST_HEADER_FIELDS_TOO_LARGE(431, "Request Header Fields Too Large"),
+    UNAVAILABLE_FOR_LEGAL_REASONS(451, "Unavailable For Legal Reasons"), // --- 5xx Server Error ---
+    INTERNAL_SERVER_ERROR(500, "Internal Server Error"),
+    NOT_IMPLEMENTED(501, "Not Implemented"),
+    BAD_GATEWAY(502, "Bad Gateway"),
+    SERVICE_UNAVAILABLE(503, "Service Unavailable"),
+    GATEWAY_TIMEOUT(504, "Gateway Timeout"),
+    HTTP_VERSION_NOT_SUPPORTED(505, "HTTP Versio    n not supported"),
+    VARIANT_ALSO_NEGOTIATES(506, "Variant Also Negotiates"),
+    INSUFFICIENT_STORAGE(507, "Insufficient Storage"),
+    LOOP_DETECTED(508, "Loop Detected"),
+    BANDWIDTH_LIMIT_EXCEEDED(509, "Bandwidth Limit Exceeded"),
+    NOT_EXTENDED(510, "Not Extended"),
+    NETWORK_AUTHENTICATION_REQUIRED(511, "Network Authentication Required");
+
+    companion object {
+
+        /**
+         * 根据[code]查询HttpStatus
+         * 当[code]对应的HttpStatus不存在时抛出[IllegalArgumentException]异常
+         */
+        fun ofCode(code: Int): HttpStatus {
+            return ofCodeOrNull(code) ?: throw IllegalArgumentException("No matching constant for [$code]")
+        }
+
+        /**
+         * 根据[code]查询HttpStatus
+         * 当[code]对应的HttpStatus不存在时返回null
+         */
+        fun ofCodeOrNull(code: Int): HttpStatus? {
+            for (status in values()) {
+                if (status.code == code) {
+                    return status
+                }
+            }
+            return null
+        }
+    }
+}

devops-boot-project/devops-boot-core/devops-api/src/main/kotlin/com/tencent/devops/api/http/MediaTypes.kt

@@ -0,0 +1,13 @@
+package com.tencent.devops.api.http
+
+/**
+ * HTTP Media Type常量
+ */
+object MediaTypes {
+    const val APPLICATION_OCTET_STREAM = "application/octet-stream"
+    const val APPLICATION_JSON = "application/json; charset=utf-8"
+    const val TEXT_HTML = "text/html"
+    const val APPLICATION_YAML = "application/x-yaml"
+    const val APPLICATION_TGZ = "application/x-tar"
+    const val APPLICATION_ICO = "image/x-icon"
+}

devops-boot-project/devops-boot-core/devops-api/src/main/kotlin/com/tencent/devops/api/pojo/Response.kt

@@ -0,0 +1,57 @@
+package com.tencent.devops.api.pojo
+
+import com.fasterxml.jackson.annotation.JsonIgnore
+import io.swagger.annotations.ApiModel
+import io.swagger.annotations.ApiModelProperty
+
+@ApiModel("数据返回包装模型")
+data class Response<out T>(
+    @ApiModelProperty("返回码")
+    val code: Int,
+    @ApiModelProperty("提示信息")
+    val message: String? = null,
+    @ApiModelProperty("数据")
+    val data: T? = null
+) {
+    /**
+     * 根据返回码判断是否成功
+     */
+    @JsonIgnore
+    fun isOk(): Boolean {
+        return code == SUCCESS
+    }
+
+    /**
+     * 根据返回码判断是否失败
+     */
+    @JsonIgnore
+    fun isNotOk(): Boolean {
+        return !isOk()
+    }
+
+    companion object {
+
+        /**
+         * 成功返回码
+         */
+        private const val SUCCESS = 0
+
+        /**
+         * 成功响应体，返回数据为空
+         */
+        fun success() = Response(SUCCESS, null, null)
+
+        /**
+         * 成功响应体
+         * @param data 数据
+         */
+        fun <T> success(data: T) = Response(SUCCESS, null, data)
+
+        /**
+         *  错误响应体
+         *  @param code 错误返回码
+         *  @param message 错误提示信息
+         */
+        fun fail(code: Int, message: String) = Response<Void>(code, message, null)
+    }
+}

devops-boot-project/devops-boot-core/devops-boot/build.gradle.kts

@@ -1 +1,5 @@
-description = "DevOps Boot"
+description = "DevOps Boot"
+
+dependencies {
+    compileOnly("org.springframework.boot:spring-boot")
+}

devops-boot-project/devops-boot-core/devops-boot/src/main/kotlin/com/tencent/devops/boot/DevOpsApplicationExtensions.kt

@@ -0,0 +1,12 @@
+package com.tencent.devops.boot
+
+import org.springframework.boot.SpringApplication
+import org.springframework.context.ConfigurableApplicationContext
+
+/**
+ * SpringBoot 提供的runApplication(vararg args: String)方法使用了kotlin的变长参数传递，会导致detekt提示`SpreadOperator`问题
+ * 利用数组传递可以避免此问题
+ */
+inline fun <reified T : Any> runApplication(args: Array<String>): ConfigurableApplicationContext {
+    return SpringApplication.run(arrayOf(T::class.java), args)
+}