up: swoft-cloud/swoft/issues/1292 allow use empty string on RequestMa…

…pping.route
swoft-cloud · May 15, 2020 · 36cca20 · 36cca20
1 parent 6f50b7d
commit 36cca20
Show file tree

Hide file tree

Showing 10 changed files with 65 additions and 34 deletions.
diff --git a/src/http-server/src/Annotation/Mapping/RequestMapping.php b/src/http-server/src/Annotation/Mapping/RequestMapping.php
@@ -20,8 +20,14 @@
  *
  * @since 2.0
  */
-class RequestMapping
+final class RequestMapping
 {
+    // If route path:
+    // - use "", eg: `@RequestMapping("")`
+    // - or use "@prefix", eg: `@RequestMapping("@prefix")`
+    // Will use the route prefix(Controller.prefix) as route.
+    public const USE_PREFIX = '@prefix';
+
     /**
      * Action routing path
      *
@@ -58,10 +64,17 @@ class RequestMapping
      */
     public function __construct(array $values)
     {
+        $route = null;
         if (isset($values['value'])) {
-            $this->route = (string)$values['value'];
+            $route = (string)$values['value'];
         } elseif (isset($values['route'])) {
-            $this->route = (string)$values['route'];
+            $route = (string)$values['route'];
+        }
+
+        if (isset($route)) {
+            // If use "", eg: `@RequestMapping("")`
+            // Will use the route prefix as route.
+            $this->route = $route === '' ? self::USE_PREFIX : $route;
         }
 
         if (isset($values['name'])) {

diff --git a/src/http-server/src/Formatter/AcceptResponseFormatter.php b/src/http-server/src/Formatter/AcceptResponseFormatter.php
@@ -10,7 +10,6 @@
 namespace Swoft\Http\Server\Formatter;
 
 use Swoft\Bean\Annotation\Mapping\Bean;
-use Swoft\Exception\SwoftException;
 use Swoft\Http\Message\ContentType;
 use Swoft\Http\Message\Contract\ResponseFormatterInterface;
 use Swoft\Http\Message\Response;
@@ -51,7 +50,6 @@ class AcceptResponseFormatter implements ResponseFormatterInterface
      * @param Response $response
      *
      * @return Response
-     * @throws SwoftException
      */
     public function format(Response $response): Response
     {

diff --git a/src/http-server/src/HttpDispatcher.php b/src/http-server/src/HttpDispatcher.php
@@ -14,7 +14,6 @@
 use Swoft\Bean\Annotation\Mapping\Inject;
 use Swoft\Concern\AbstractDispatcher;
 use Swoft\Context\Context;
-use Swoft\Exception\SwoftException;
 use Swoft\Http\Message\Request;
 use Swoft\Http\Message\Response;
 use Swoft\Http\Server\Formatter\AcceptResponseFormatter;
@@ -60,8 +59,6 @@ class HttpDispatcher extends AbstractDispatcher
      * Dispatch http request
      *
      * @param mixed ...$params
-     *
-     * @throws SwoftException
      */
     public function dispatch(...$params): void
     {

diff --git a/src/http-server/src/Router/RouteRegister.php b/src/http-server/src/Router/RouteRegister.php
@@ -10,6 +10,7 @@
 
 namespace Swoft\Http\Server\Router;
 
+use Swoft\Http\Server\Annotation\Mapping\RequestMapping;
 use Swoft\Stdlib\Helper\Str;
 use function rtrim;
 
@@ -81,9 +82,16 @@ public static function registerRoutes(Router $router): void
                 // Ensure is not empty
                 $routePath = $route['route'] ?: $route['action'];
 
-                // A route starting with '/' is a separate route
-                // Unused '/' needs to be combined with the controller group into a route
-                $path    = $routePath[0] === '/' ? $routePath : $prefix . '/' . $routePath;
+                // If use "", eg: `@RequestMapping("")`
+                // Will use the route prefix(Controller.prefix) as route.
+                if ($routePath === RequestMapping::USE_PREFIX) {
+                    $path = $prefix;
+                } else {
+                    // A route starting with '/' is a separate route
+                    // Unused '/' needs to be combined with the controller group into a route
+                    $path = $routePath[0] === '/' ? $routePath : $prefix . '/' . $routePath;
+                }
+
                 $handler = $class . '@' . $route['action'];
 
                 $router->map($route['method'], $path, $handler, $route['params'], [

diff --git a/src/http-server/test/testing/Controller/RouteController.php b/src/http-server/test/testing/Controller/RouteController.php
@@ -12,6 +12,7 @@
 use Swoft\Http\Server\Annotation\Mapping\Controller;
 use Swoft\Http\Server\Annotation\Mapping\RequestMapping;
 use Swoft\Http\Server\Annotation\Mapping\RequestMethod;
+use function context;
 
 /**
  * Class RouteController
@@ -24,6 +25,16 @@ class RouteController extends BaseController
 {
     use TraitController;
 
+    /**
+     * @RequestMapping("")
+     *
+     * @return string
+     */
+    public function testRoute(): string
+    {
+        return 'testRoute';
+    }
+
     /**
      * @RequestMapping("string")
      *
@@ -70,8 +81,7 @@ public function data(): array
      */
     public function parser(): array
     {
-        $body = \context()->getRequest()->getParsedBody();
-        return $body;
+        return context()->getRequest()->getParsedBody();
     }
 
     /**

diff --git a/src/http-server/test/testing/Controller/TestController.php b/src/http-server/test/testing/Controller/TestController.php
@@ -21,6 +21,15 @@
  */
 class TestController
 {
+    /**
+     * @RequestMapping("@prefix")
+     * @return string
+     */
+    public function home(): string
+    {
+        return 'home';
+    }
+
     /**
      * @RequestMapping()
      * @return string

diff --git a/src/http-server/test/testing/MockHttpServer.php b/src/http-server/test/testing/MockHttpServer.php
@@ -12,7 +12,6 @@
 use RuntimeException;
 use Swoft\Bean\Annotation\Mapping\Bean;
 use Swoft\Bean\BeanFactory;
-use Swoft\Exception\SwoftException;
 use Swoft\Http\Message\Request as ServerRequest;
 use Swoft\Http\Message\Response as ServerResponse;
 use Swoft\Http\Server\HttpDispatcher;
@@ -37,7 +36,6 @@ class MockHttpServer
      * @param array  $ext
      *
      * @return MockResponse
-     * @throws SwoftException
      */
     public function request(
         string $method,
@@ -96,7 +94,6 @@ public function mockRequest(
      * @param Response $response
      *
      * @return ServerResponse
-     * @throws SwoftException
      */
     public function onRequest(Request $request, Response $response): ServerResponse
     {

diff --git a/src/http-server/test/unit/ResponseTest.php b/src/http-server/test/unit/ResponseTest.php
@@ -9,7 +9,6 @@
  */
 namespace SwoftTest\Http\Server\Unit;
 
-use Swoft\Exception\SwoftException;
 use Swoft\Http\Message\ContentType;
 use SwoftTest\Http\Server\Testing\Controller\TestController;
 use SwoftTest\Http\Server\Testing\MockRequest;
@@ -21,9 +20,14 @@
  */
 class ResponseTest extends HttpServerTestCase
 {
-    /**
-     * @throws SwoftException
-     */
+    public function testRoute(): void
+    {
+        /** @see TestController */
+        $response = $this->mockServer->request(MockRequest::GET, '/fixture/test');
+
+        $response->assertEqualJson(['data' => 'home']);
+    }
+
     public function testCookie(): void
     {
         /** @see TestController */
@@ -34,9 +38,6 @@ public function testCookie(): void
         $this->assertSame('ck=val', $cks['ck']);
     }
 
-    /**
-     * @throws SwoftException
-     */
     public function testHtml(): void
     {
         /** @see TestController */

diff --git a/src/http-server/test/unit/RestTest.php b/src/http-server/test/unit/RestTest.php
@@ -20,10 +20,7 @@
  */
 class RestTest extends HttpServerTestCase
 {
-    /**
-     * @throws \Swoft\Exception\SwoftException
-     */
-    public function testList()
+    public function testList(): void
     {
         $headers = [
             ContentType::KEY => ContentType::JSON
@@ -33,9 +30,7 @@ public function testList()
         $response->assertEqualJson(['list']);
     }
 
-    /**
-     */
-    public function testCreate()
+    public function testCreate(): void
     {
         $headers = [
             ContentType::KEY => ContentType::JSON
@@ -53,7 +48,7 @@ public function testCreate()
         $response->assertEqualJson($data);
     }
 
-    public function testGetUser()
+    public function testGetUser(): void
     {
         $headers = [
             ContentType::KEY => ContentType::JSON
@@ -72,7 +67,7 @@ public function testGetUser()
         $response->assertEqualJson(['getUser', 0]);
     }
 
-    public function testGetBookFromUser()
+    public function testGetBookFromUser(): void
     {
         $headers = [
             ContentType::KEY => ContentType::JSON
@@ -88,7 +83,7 @@ public function testGetBookFromUser()
         $response->assertEqualJson($data);
     }
 
-    public function testDelete()
+    public function testDelete(): void
     {
         $headers = [
             ContentType::KEY => ContentType::JSON
@@ -103,7 +98,7 @@ public function testDelete()
         $response->assertEqualJson($data);
     }
 
-    public function testUpdate()
+    public function testUpdate(): void
     {
         $headers = [
             ContentType::KEY => ContentType::JSON

diff --git a/src/http-server/test/unit/RouteTest.php b/src/http-server/test/unit/RouteTest.php
@@ -35,6 +35,9 @@ public function testReturnType(): void
 
         $response = $this->mockServer->request(MockRequest::GET, '/testRoute/null');
         $response->assertEqualContent('{}');
+
+        $response = $this->mockServer->request(MockRequest::GET, '/testRoute');
+        $response->assertEqualJson(['data' => 'testRoute']);
     }
 
     /**