Как передать URL-аргументы (строку запроса) в HTTP-запрос на Angular?


266

Я создаю HTTP-запрос на Angular, но я не знаю, как добавить к нему аргументы URL (строку запроса).

this.http.get(StaticSettings.BASE_URL).subscribe(
  (response) => this.onGetForecastResult(response.json()),
  (error) => this.onGetForecastError(error.json()),
  () => this.onGetForecastComplete()
);

Теперь мой StaticSettings.BASE_URL похож на URL без строки запроса, например: http://atsomeplace.com/, но я хочу, чтобы он был http://atsomeplace.com/?var1=val1&var2=val2.

Где var1 и var2 подходят для моего объекта запроса Http? Я хочу добавить их как объект.

{
  query: {
    var1: val1,
    var2: val2
  }
}

а затем только модуль Http выполняет работу, чтобы разобрать его в строку запроса URL.


stackoverflow.com/questions/26541801/… сослаться на это. Создайте URL перед вызовом и передайте его функции подписки вместо BASE_URL. 2cents
pratikpawar

Ответы:


331

В HTTPClient методы позволяют установить Params в его вариантах.

Вы можете настроить его, импортировав HttpClientModule из пакета @ angular / common / http.

import {HttpClientModule} from '@angular/common/http';

@NgModule({
  imports: [ BrowserModule, HttpClientModule ],
  declarations: [ App ],
  bootstrap: [ App ]
})
export class AppModule {}

После этого вы можете внедрить HttpClient и использовать его для выполнения запроса.

import {HttpClient} from '@angular/common/http'

@Component({
  selector: 'my-app',
  template: `
    <div>
      <h2>Hello {{name}}</h2>
    </div>
  `,
})
export class App {
  name:string;
  constructor(private httpClient: HttpClient) {
    this.httpClient.get('/url', {
      params: {
        appid: 'id1234',
        cnt: '5'
      },
      observe: 'response'
    })
    .toPromise()
    .then(response => {
      console.log(response);
    })
    .catch(console.log);
  }
}

Для угловых версий до версии 4 вы можете сделать то же самое с помощью сервиса Http .

Метод Http.get принимает объект, который реализует RequestOptionsArgs в качестве второго параметра.

Поле поиска этого объекта можно использовать для установки строки или объекта URLSearchParams .

Пример:

 // Parameters obj-
 let params: URLSearchParams = new URLSearchParams();
 params.set('appid', StaticSettings.API_KEY);
 params.set('cnt', days.toString());

 //Http request-
 return this.http.get(StaticSettings.BASE_URL, {
   search: params
 }).subscribe(
   (response) => this.onGetForecastResult(response.json()), 
   (error) => this.onGetForecastError(error.json()), 
   () => this.onGetForecastComplete()
 );

Документация по классу Http содержит более подробную информацию. Это можно найти здесь и рабочий пример здесь .


2
Суть: gist.github.com/MiguelLattuada/bb502d84854ad9fc26e0 как использовать объект URLSearchParams, еще раз спасибо @toskv
Мигель Латтуада

1
Супер пятно с URLSearchParams! Решил мою проблему с сериализацией объекта JSON.
Логан H

2
@SukumarMS на самом деле не нужно ничего особенного, потому что это часть пути. Просто объедините строки 'blabla.com/page/' + page + '/ activeFilter' + activeFilter. Или, если вы хотите использовать литералы шаблона `blabla.com/page / $ {page} / $ {activeFilter}`.
toskv

10
это работает для меня:http.get(url, {params: {var1: val1, var2: val2}})
Александр Суворов

8
searchсвойство было исключено из 4.0.0 -> использовать paramsвместо
BotanMan

180

Редактировать угловой> = 4.3.x

HttpClient был представлен вместе с HttpParams . Ниже приведен пример использования:

import { HttpParams, HttpClient } from '@angular/common/http';

constructor(private http: HttpClient) { }

let params = new HttpParams();
params = params.append('var1', val1);
params = params.append('var2', val2);

this.http.get(StaticSettings.BASE_URL, {params: params}).subscribe(...);

(Старые ответы)

Изменить угловой> = 4.x

requestOptions.searchбыл объявлен устаревшим Используйте requestOptions.paramsвместо:

let requestOptions = new RequestOptions();
requestOptions.params = params;

Оригинальный ответ (Angular 2)

Вы должны импортировать, URLSearchParamsкак показано ниже

import { Http, RequestOptions, URLSearchParams } from '@angular/http';

Затем создайте параметры и выполните http-запрос следующим образом:

let params: URLSearchParams = new URLSearchParams();
params.set('var1', val1);
params.set('var2', val2);

let requestOptions = new RequestOptions();
requestOptions.search = params;

this.http.get(StaticSettings.BASE_URL, requestOptions)
    .toPromise()
    .then(response => response.json())
...

3
Не работает для меня Я покопался в исходном коде и обнаружил, что второй параметр http.get ожидает интерфейс RequestOptionsArgs, который URLSearchParams не реализует. Обертывание searchParams внутри объекта RequestOptions работает. Было бы неплохо, хотя бы ярлык.
настойчиво

3
Вы совершенно правы, я забыл RequestOptions. Я обновил свой ответ.
Радуан Руфид,

1
Спасибо за указание на осуждение search. Исправлена ​​моя проблема
Хейден Брэкстон

Спасибо за указание на это изменение! Все документы и проблемы, которые я нашел в течение нескольких часов, говорили мне, чтобы я прикреплял параметры к searchсобственности.
rayepps

63

Версия 5+

С Angular 5 и выше, вам не нужно использовать HttpParams . Вы можете напрямую отправить свой объект json, как показано ниже.

let data = {limit: "2"};
this.httpClient.get<any>(apiUrl, {params: data});

Обратите внимание, что значения данных должны быть строковыми, т.е. { params: {limit: "2"}}

Версия 4.3.x +

Используйте HttpParams, HttpClient из @ angular / common / http

import { HttpParams, HttpClient } from '@angular/common/http';
...
constructor(private httpClient: HttpClient) { ... }
...
let params = new HttpParams();
params = params.append("page", 1);
....
this.httpClient.get<any>(apiUrl, {params: params});

Может помочь некоторым!


@BrunoPeres попробуйте привести в порядок ваш вложенный объект, используяJSON.stringify()
Rahmathullah M

1
@RahmathullahM - Bichu, THX :)
Джамшир

12

Угловой 6

Вы можете передать параметры, необходимые для получения вызова, используя параметры:

this.httpClient.get<any>(url, { params: x });

где x = {свойство: "123"}.

Что касается функции API, которая регистрирует «123»:

router.get('/example', (req, res) => {
    console.log(req.query.property);
})

2
Это было изменение, добавленное в версии 5. Уже добавлено здесь stackoverflow.com/a/45455904/3276721
Мигель Латтуада

9

Мой пример

private options = new RequestOptions({headers: new Headers({'Content-Type': 'application/json'})});

Мой метод

  getUserByName(name: string): Observable<MyObject[]> {
    //set request params
    let params: URLSearchParams = new URLSearchParams();
    params.set("name", name);
    //params.set("surname", surname); for more params
    this.options.search = params;

    let url = "http://localhost:8080/test/user/";
    console.log("url: ", url);

    return this.http.get(url, this.options)
      .map((resp: Response) => resp.json() as MyObject[])
      .catch(this.handleError);
  }

  private handleError(err) {
    console.log(err);
    return Observable.throw(err || 'Server error');
  }

в моем компоненте

  userList: User[] = [];
  this.userService.getUserByName(this.userName).subscribe(users => {
      this.userList = users;
    });

Почтальоном

http://localhost:8080/test/user/?name=Ethem

6

В последней версии Angular 7/8 вы можете использовать самый простой подход: -

import { HttpClient, HttpHeaders, HttpParams } from '@angular/common/http';

getDetails(searchParams) {
    const httpOptions = {
        headers: { 'Content-Type': 'application/json' },
        params: { ...searchParams}
    };
    return this.http.get(this.Url, httpOptions);
}

Это не будет работать, если любое из searchParamsсвойств не является stringзначением.
Юлиан

5

Если вы планируете отправить более одного параметра.

Составная часть

private options = {
  sort:   '-id',
  select: null,
  limit:  1000,
  skip:   0,
  from:   null,
  to:     null
};

constructor(private service: Service) { }

ngOnInit() {
  this.service.getAllItems(this.options)
    .subscribe((item: Item[]) => {
      this.item = item;
    });
}

обслуживание

private options = new RequestOptions({headers: new Headers({'Content-Type': 'application/json'})});
constructor(private http: Http) { }

getAllItems(query: any) {
  let params: URLSearchParams = new URLSearchParams();
  for(let key in query){
    params.set(key.toString(), query[key]);
  }
  this.options.search = params;
  this.header = this.headers();

И продолжайте ваш запрос http, как это сделал @ethemsulan.

Серверный маршрут

router.get('/api/items', (req, res) => {
  let q = {};
  let skip = req.query.skip;
  let limit = req.query.limit;
  let sort  = req.query.sort;
  q.from = req.query.from;
  q.to = req.query.to;

  Items.find(q)
    .skip(skip)
    .limit(limit)
    .sort(sort)
    .exec((err, items) => {
      if(err) {
        return res.status(500).json({
          title: "An error occurred",
          error: err
        });
      }
      res.status(200).json({
        message: "Success",
        obj:  items
      });
    });
});

В запросе get вашего сервиса мне не хватает того, как вы обрабатываете запрос get.
Виннемукка

О, я думаю, вы бы поместили запрос http get в этом методе в качестве возврата, как ответ
ethumsulan

2

Вы можете использовать HttpParams из @ angular / common / http и передать строку с запросом. Например:

import { HttpClient, HttpParams } from '@angular/common/http';
const query = 'key=value' // date=2020-03-06

const options = {
  params: new HttpParams({
    fromString: query
  })
}

Теперь в вашем коде

this.http.get(urlFull, options);

И это работает для вас :)

Я надеюсь помочь тебе


0
import ...
declare var $:any;
...
getSomeEndPoint(params:any): Observable<any[]> {
    var qStr = $.param(params); //<---YOUR GUY
    return this._http.get(this._adUrl+"?"+qStr)
      .map((response: Response) => <any[]> response.json())
      .catch(this.handleError);
}

при условии, что вы установили jQuery , я делаю npm i jquery --saveи включаю apps.scriptsвangular-cli.json


0
import { Http, Response } from '@angular/http';
constructor(private _http: Http, private router: Router) {
}

return this._http.get('http://url/login/' + email + '/' + password)
       .map((res: Response) => {
           return res.json();
        }).catch(this._handleError);

Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.