Преобразование объекта JS в данные

129

Как я могу преобразовать свой объект JS в FormData?

Причина, по которой я хочу это сделать, заключается в том, что у меня есть объект, который я построил из ~ 100 значений поля формы.

var item = {
   description: 'Some Item',
   price : '0.00',
   srate : '0.00',
   color : 'red',
   ...
   ...
}

Теперь меня просят добавить функцию загрузки файла в мою форму, что, конечно, невозможно через JSON, поэтому я планирую перейти на FormData. Итак, есть ли способ преобразовать мой объект JS FormData?

Камран Ахмед
источник
можешь поделиться своей работой / прогрессом?
Ритикеш 01
как насчет JSON.stringify ()?
Санни Шарма
1
@Sunny - это создаст текст JSON в строке. Это не FormDataобъект.
Квентин
Да, вы можете, вы можете добавлять к объектам formData.
adeneo 01
вы можете показать нам, что вы подразумеваете под FormData? какой-то конкретный формат?
Санни Шарма

Ответы:

156

Если у вас есть объект, вы можете легко создать объект FormData и добавить имена и значения из этого объекта в formData.

Вы не опубликовали никакого кода, поэтому это общий пример;

var form_data = new FormData();

for ( var key in item ) {
    form_data.append(key, item[key]);
}

$.ajax({
    url         : 'http://example.com/upload.php',
    data        : form_data,
    processData : false,
    contentType : false,
    type: 'POST'
}).done(function(data){
    // do stuff
});

В документации по MDN есть больше примеров.

adeneo
источник
4
@Lior - itemэто обычный объект, созданный OP, поэтому он не должен иметь никаких свойств, которые ему не принадлежат, если только кто-то не допустил ошибку, создав прототип чего-то в конструкторе объекта, и в этом случае вы окажетесь в мире проблем , и это не то, от чего мы должны защищаться.
adeneo
2
@Lior - он просто добавляет пары ключ / значение в FormData, добавляя прототипное свойство, которое ничего не сломает, и использование Object.keysне является ответом, так как вам не нужно получать ключи в виде массива, а затем перебирать ключи, чтобы получить значения, вы должны использовать for..inцикл.
adeneo
2
Конечно, будет, вы не знаете, чего ожидает сервер ... поскольку ... in в JS является проблематичным, решение не обязательно должно быть Object.keys (), это может быть hasOwnProperty (), но это должно быть как минимум предупреждение.
Лиор
3
@Lior - Если ваш сервер выходит из строя, когда он получает еще одну пару ключ / значение в запросе POST, вы делаете это неправильно. Я думаю, что с ответом все в порядке, и я не собираюсь менять его для использования Object.keysили hasOwnProperty()поскольку объект размещен в вопросе, и он не должен нуждаться в любом из них. Причина, по которой вы иногда видите hasOwnPropertyиспользование плагинов и т. Д., Заключается в том, что вы никогда не знаете, что некоторые люди могут сделать с Objectконструктором, но по большей части людям не нужно тестировать унаследованные свойства на объектах, которые они создали, это признак того, что ты наверное что-то делаешь не так.
adeneo
5
@ Лиор, ты собираешься строить самолеты из соломы в следующий раз, надеясь, что это привлечет больше настоящих самолетов, которые будут сбрасывать еду с неба? Важно понимать, почему используется проверка hasOwnProperty, просто говоря, что вещи считаются «лучшей практикой», потому что вы читаете чью-то книгу (предположение, Крокфорда) не очень продвинетесь, пытаясь обучить товарища члена So более 100 раз репутация и 100-кратное количество ответов тоже не очень помогают вашей точке зрения. Также, как назвать одну новую стороннюю библиотеку, которая изменяет прототип? Этот пост из другого времени ...
Бенджамин Грюнбаум
85

С ES6 и более функциональным подходом к программированию ответ @ adeneo может выглядеть так:

function getFormData(object) {
    const formData = new FormData();
    Object.keys(object).forEach(key => formData.append(key, object[key]));
    return formData;
}

Или, как вариант, используя .reduce()и стрелочные функции:

getFormData = object => Object.keys(object).reduce((formData, key) => {
    formData.append(key, object[key]);
    return formData;
}, new FormData());
Джейкоб Лауритцен
источник
45

Эта функция добавляет все данные из объекта в FormData

Версия ES6 от @ developer033:

function buildFormData(formData, data, parentKey) {
  if (data && typeof data === 'object' && !(data instanceof Date) && !(data instanceof File)) {
    Object.keys(data).forEach(key => {
      buildFormData(formData, data[key], parentKey ? `${parentKey}[${key}]` : key);
    });
  } else {
    const value = data == null ? '' : data;

    formData.append(parentKey, value);
  }
}

function jsonToFormData(data) {
  const formData = new FormData();

  buildFormData(formData, data);

  return formData;
}

const my_data = {
  num: 1,
  falseBool: false,
  trueBool: true,
  empty: '',
  und: undefined,
  nullable: null,
  date: new Date(),
  name: 'str',
  another_object: {
    name: 'my_name',
    value: 'whatever'
  },
  array: [
    {
      key1: {
        name: 'key1'
      }
    }
  ]
};

jsonToFormData(my_data)

версия jQuery:

function appendFormdata(FormData, data, name){
    name = name || '';
    if (typeof data === 'object'){
        $.each(data, function(index, value){
            if (name == ''){
                appendFormdata(FormData, value, index);
            } else {
                appendFormdata(FormData, value, name + '['+index+']');
            }
        })
    } else {
        FormData.append(name, data);
    }
}


var formData = new FormData(),
    your_object = {
        name: 'test object',
        another_object: {
            name: 'and other objects',
            value: 'whatever'
        }
    };
appendFormdata(formData, your_object);
Владимир Новопашин
источник
Вивек Доши
Работает очень хорошо! Спасибо! Мне также пришлось добавить && !(data instanceof Blob)в моем случае, чтобы загрузить свои изображения
Клеман Баконье
У меня хорошо работает, я добавил if (typeof data === 'object' && data! == null) {потому что он генерировал исключение, если значение null
al000y
Для версии ES6 я добавил && !(Array.isArray(data) && !data.length)условие «если», иначе пустой массив будет удален.
Mtxz
Это гениально. Решил мою проблему очень красиво.
дорогая
15

Остальные ответы были для меня неполными. Я начал с ответа @Vladimir Novopashin и изменил его. Вот что мне было нужно и что я обнаружил:

  • Поддержка файла
  • Поддержка массива
  • Ошибка: файл внутри сложного объекта нужно добавлять с помощью .propвместо [prop]. Например formData.append('photos[0][file]', file)не работал на google chrome, пока formData.append('photos[0].file', file)работал
  • Игнорировать некоторые свойства в моем объекте

Следующий код должен работать в IE11 и вечнозеленых браузерах.

function objectToFormData(obj, rootName, ignoreList) {
    var formData = new FormData();

    function appendFormData(data, root) {
        if (!ignore(root)) {
            root = root || '';
            if (data instanceof File) {
                formData.append(root, data);
            } else if (Array.isArray(data)) {
                for (var i = 0; i < data.length; i++) {
                    appendFormData(data[i], root + '[' + i + ']');
                }
            } else if (typeof data === 'object' && data) {
                for (var key in data) {
                    if (data.hasOwnProperty(key)) {
                        if (root === '') {
                            appendFormData(data[key], key);
                        } else {
                            appendFormData(data[key], root + '.' + key);
                        }
                    }
                }
            } else {
                if (data !== null && typeof data !== 'undefined') {
                    formData.append(root, data);
                }
            }
        }
    }

    function ignore(root){
        return Array.isArray(ignoreList)
            && ignoreList.some(function(x) { return x === root; });
    }

    appendFormData(obj, rootName);

    return formData;
}
Gudradain
источник
2
Единственный ответ, поддерживающий массивы, объекты и файлы.
сотн 04
Привет, зачем вы добавляете Файл в корень? Можно ли добавить его и к ребенку?
Cedric Arnould
@CedricArnould Это может быть недоразумение, но метод рекурсивен, поэтому даже если он написан formData.append(root, data), это не означает, что он добавлен в корень.
Gudradain
Я понимаю ваш ответ, как ни странно, когда я получаю результат на сервере, у меня есть уникальная Коллекция файлов и данных. Но я вижу в файле, что имя дает информацию, к которому он подключен. Возможно, проблема связана с .Net Core и тем, как он управляет загружаемыми файлами. Спасибо за Ваш ответ.
Седрик Арноулд
Я пытаюсь использовать это, но нет примера использования. ожидаемый формат параметра ignoreList был бы очень полезен.
jpro
9

Попробуйте функцию JSON.stringify, как показано ниже

var postData = JSON.stringify(item);
var formData = new FormData();
formData.append("postData",postData );
Удайрадж Хуман
источник
1
Это лучший способ добиться этого.
Роб
его сохранить, добавив json после нескольких
Snow Bases
7

У меня был сценарий, в котором вложенный JSON должен был быть сериализован линейным образом при построении данных формы, поскольку именно так сервер ожидает значения. Итак, я написал небольшую рекурсивную функцию, которая переводит JSON, который выглядит так:

{
   "orderPrice":"11",
   "cardNumber":"************1234",
   "id":"8796191359018",
   "accountHolderName":"Raj Pawan",
   "expiryMonth":"02",
   "expiryYear":"2019",
   "issueNumber":null,
   "billingAddress":{
      "city":"Wonderland",
      "code":"8796682911767",
      "firstname":"Raj Pawan",
      "lastname":"Gumdal",
      "line1":"Addr Line 1",
      "line2":null,
      "state":"US-AS",
      "region":{
         "isocode":"US-AS"
      },
      "zip":"76767-6776"
   }
}

Примерно так:

{
   "orderPrice":"11",
   "cardNumber":"************1234",
   "id":"8796191359018",
   "accountHolderName":"Raj Pawan",
   "expiryMonth":"02",
   "expiryYear":"2019",
   "issueNumber":null,
   "billingAddress.city":"Wonderland",
   "billingAddress.code":"8796682911767",
   "billingAddress.firstname":"Raj Pawan",
   "billingAddress.lastname":"Gumdal",
   "billingAddress.line1":"Addr Line 1",
   "billingAddress.line2":null,
   "billingAddress.state":"US-AS",
   "billingAddress.region.isocode":"US-AS",
   "billingAddress.zip":"76767-6776"
}

Сервер будет принимать данные формы в этом преобразованном формате.

Вот функция:

function jsonToFormData (inJSON, inTestJSON, inFormData, parentKey) {
    // http://stackoverflow.com/a/22783314/260665
    // Raj: Converts any nested JSON to formData.
    var form_data = inFormData || new FormData();
    var testJSON = inTestJSON || {};
    for ( var key in inJSON ) {
        // 1. If it is a recursion, then key has to be constructed like "parent.child" where parent JSON contains a child JSON
        // 2. Perform append data only if the value for key is not a JSON, recurse otherwise!
        var constructedKey = key;
        if (parentKey) {
            constructedKey = parentKey + "." + key;
        }

        var value = inJSON[key];
        if (value && value.constructor === {}.constructor) {
            // This is a JSON, we now need to recurse!
            jsonToFormData (value, testJSON, form_data, constructedKey);
        } else {
            form_data.append(constructedKey, inJSON[key]);
            testJSON[constructedKey] = inJSON[key];
        }
    }
    return form_data;
}

Призвание:

        var testJSON = {};
        var form_data = jsonToFormData (jsonForPost, testJSON);

Я использую testJSON только для просмотра преобразованных результатов, так как я не смогу извлечь содержимое form_data. Пост-вызов AJAX:

        $.ajax({
            type: "POST",
            url: somePostURL,
            data: form_data,
            processData : false,
            contentType : false,
            success: function (data) {
            },
            error: function (e) {
            }
        });
Радж Паван Гумдал
источник
Привет, Радж, а как насчет массивов? Предположим, у вас более 1 платежных адресов. Как бы вы это исправить?
Сэм
1
Я нашел ответ! Ваш пост действительно полезен. Спасибо!
Сэм
3

Извините за поздний ответ, но я боролся с этим, поскольку Angular 2 в настоящее время не поддерживает загрузку файлов. Итак, способ сделать это - отправить с XMLHttpRequestпомощью FormData. Итак, я создал функцию для этого. Я использую Typescript . Чтобы преобразовать его в Javascript, просто удалите объявление типов данных.

/**
     * Transforms the json data into form data.
     *
     * Example:
     *
     * Input:
     * 
     * fd = new FormData();
     * dob = {
     *  name: 'phone',
     *  photos: ['myphoto.jpg', 'myotherphoto.png'],
     *  price: '615.99',
     *  color: {
     *      front: 'red',
     *      back: 'blue'
     *  },
     *  buttons: ['power', 'volup', 'voldown'],
     *  cameras: [{
     *      name: 'front',
     *      res: '5Mpx'
     *  },{
     *      name: 'back',
     *      res: '10Mpx'
     *  }]
     * };
     * Say we want to replace 'myotherphoto.png'. We'll have this 'fob'.
     * fob = {
     *  photos: [null, <File object>]
     * };
     * Say we want to wrap the object (Rails way):
     * p = 'product';
     *
     * Output:
     *
     * 'fd' object updated. Now it will have these key-values "<key>, <value>":
     *
     * product[name], phone
     * product[photos][], myphoto.jpg
     * product[photos][], <File object>
     * product[color][front], red
     * product[color][back], blue
     * product[buttons][], power
     * product[buttons][], volup
     * product[buttons][], voldown
     * product[cameras][][name], front
     * product[cameras][][res], 5Mpx
     * product[cameras][][name], back
     * product[cameras][][res], 10Mpx
     * 
     * @param {FormData}  fd  FormData object where items will be appended to.
     * @param {Object}    dob Data object where items will be read from.
     * @param {Object =   null} fob File object where items will override dob's.
     * @param {string =   ''} p Prefix. Useful for wrapping objects and necessary for internal use (as this is a recursive method).
     */
    append(fd: FormData, dob: Object, fob: Object = null, p: string = ''){
        let apnd = this.append;

        function isObj(dob, fob, p){
            if(typeof dob == "object"){
                if(!!dob && dob.constructor === Array){
                    p += '[]';
                    for(let i = 0; i < dob.length; i++){
                        let aux_fob = !!fob ? fob[i] : fob;
                        isObj(dob[i], aux_fob, p);
                    }
                } else {
                    apnd(fd, dob, fob, p);
                }
            } else {
                let value = !!fob ? fob : dob;
                fd.append(p, value);
            }
        }

        for(let prop in dob){
            let aux_p = p == '' ? prop : `${p}[${prop}]`;
            let aux_fob = !!fob ? fob[prop] : fob;
            isObj(dob[prop], aux_fob, aux_p);
        }
    }
Aleksandrus
источник
Вы должны включить индексы массива вместо []свойств объекта внутри числового массива, чтобы не
повредить его
1

Версия TypeScript:

static convertModelToFormData(model: any, form: FormData = null, namespace = ''): FormData {
    let formData = form || new FormData();
    for (let propertyName in model) {
      if (!model.hasOwnProperty(propertyName) || model[propertyName] == undefined) continue;
      let formKey = namespace ? `${namespace}[${propertyName}]` : propertyName;
      if (model[propertyName] instanceof Date) {        
        formData.append(formKey, this.dateTimeToString(model[propertyName]));
      }
      else if (model[propertyName] instanceof Array) {
        model[propertyName].forEach((element, index) => {
          if (typeof element != 'object')
            formData.append(`${formKey}[]`, element);
          else {
            const tempFormKey = `${formKey}[${index}]`;
            this.convertModelToFormData(element, formData, tempFormKey);
          }
        });
      }
      else if (typeof model[propertyName] === 'object' && !(model[propertyName] instanceof File)) {        
        this.convertModelToFormData(model[propertyName], formData, formKey);
      }
      else {        
        formData.append(formKey, model[propertyName].toString());
      }
    }
    return formData;
  }

https://gist.github.com/Mds92/091828ea857cc556db2ca0f991fee9f6

Мохаммад Дайян
источник
1
Прежде всего, namespaceэто зарезервированное ключевое слово в TypeScript( typescriptlang.org/docs/handbook/namespaces.html и github.com/Microsoft/TypeScript/issues/… ). Кроме того , кажется , что вы забыли иметь дело с Fileмомента последней elseволи append "[object File]"к formData.
Jyrkka
1

Вы можете просто установить qs:

npm i qs

Просто импортируйте:

import qs from 'qs'

Передать объект qs.stringify():

var item = {
   description: 'Some Item',
   price : '0.00',
   srate : '0.00',
   color : 'red',
   ...
   ...
}

qs.stringify(item)
Баладж Хан
источник
1

Рекурсивный

const toFormData = (f => f(f))(h => f => f(x => h(h)(f)(x)))(f => fd => pk => d => {
  if (d instanceof Object) {
    Object.keys(d).forEach(k => {
      const v = d[k]
      if (pk) k = `${pk}[${k}]`
      if (v instanceof Object && !(v instanceof Date) && !(v instanceof File)) {
        return f(fd)(k)(v)
      } else {
        fd.append(k, v)
      }
    })
  }
  return fd
})(new FormData())()

let data = {
  name: 'John',
  age: 30,
  colors: ['red', 'green', 'blue'],
  children: [
    { name: 'Max', age: 3 },
    { name: 'Madonna', age: 10 }
  ]
}
console.log('data', data)
document.getElementById("data").insertAdjacentHTML('beforeend', JSON.stringify(data))

let formData = toFormData(data)

for (let key of formData.keys()) {
  console.log(key, formData.getAll(key).join(','))
  document.getElementById("item").insertAdjacentHTML('beforeend', `<li>${key} = ${formData.getAll(key).join(',')}</li>`)
}
<p id="data"></p>
<ul id="item"></ul>

vmartins
источник
лучший ответ imho
ling
0

Этот метод преобразует объект JS в FormData:

function convertToFormData(params) {
    return Object.entries(params)
        .reduce((acc, [key, value]) => {
            if (Array.isArray(value)) {
                value.forEach((v, k) => acc.append(`${key}[${k}]`, value));
            } else if (typeof value === 'object' && !(value instanceof File) && !(value instanceof Date)) {
                Object.entries(value).forEach((v, k) => acc.append(`${key}[${k}]`, value));
            } else {
                acc.append(key, value);
            }

            return acc;
        }, new FormData());
}

Обезьяна-монах
источник
Просто исправьте итерацию вызова записей вложенных объектов: Object.entries(value).forEach((v, k) => acc.append(`${key}[${v[0]}]`, v[1]));
heber gentilin
0

В моем случае у моего объекта также было свойство, которое было массивом файлов. Поскольку они бинарные, с ними следует обращаться по-другому - индекс не обязательно должен быть частью ключа. Итак, я изменил ответ @Vladimir Novopashin и @ developer033:

export function convertToFormData(data, formData, parentKey) {
  if(data === null || data === undefined) return null;

  formData = formData || new FormData();

  if (typeof data === 'object' && !(data instanceof Date) && !(data instanceof File)) {
    Object.keys(data).forEach(key => 
      convertToFormData(data[key], formData, (!parentKey ? key : (data[key] instanceof File ? parentKey : `${parentKey}[${key}]`)))
    );
  } else {
    formData.append(parentKey, data);
  }

  return formData;
}
Elnoor
источник
0

Я использовал это для публикации моих данных объекта как данных формы.

const encodeData = require('querystring');

const object = {type: 'Authorization', username: 'test', password: '123456'};

console.log(object);
console.log(encodeData.stringify(object));
Юнус ER
источник
0

Возможно, вы ищете этот код, который получает ваш объект javascript, создает из него объект FormData и затем отправляет его на свой сервер с помощью нового Fetch API :

    let myJsObj = {'someIndex': 'a value'};

    let datos = new FormData();
    for (let i in myJsObj){
        datos.append( i, myJsObj[i] );
    }

    fetch('your.php', {
        method: 'POST',
        body: datos
    }).then(response => response.json())
        .then(objson => {
            console.log('Success:', objson);
        })
        .catch((error) => {
            console.error('Error:', error);
        });
Освальдо Родригес Гонсалес
источник
0

Я ссылаюсь на это из ответа Гудрадаина . Немного редактирую в формате Typescript.

class UtilityService {
    private appendFormData(formData, data, rootName) {

        let root = rootName || '';
        if (data instanceof File) {
            formData.append(root, data);
        } else if (Array.isArray(data)) {
            for (var i = 0; i < data.length; i++) {
                this.appendFormData(formData, data[i], root + '[' + i + ']');
            }
        } else if (typeof data === 'object' && data) {
            for (var key in data) {
                if (data.hasOwnProperty(key)) {
                    if (root === '') {
                        this.appendFormData(formData, data[key], key);
                    } else {
                        this.appendFormData(formData, data[key], root + '.' + key);
                    }
                }
            }
        } else {
            if (data !== null && typeof data !== 'undefined') {
                formData.append(root, data);
            }
        }
    }

    getFormDataFromObj(data) {
        var formData = new FormData();

        this.appendFormData(formData, data, '');

        return formData;
    }
}

export let UtilityMan = new UtilityService();
Михаэль Прамодана
источник
0

Возможно, я немного опоздал на вечеринку, но это то, что я создал для преобразования единственного объекта в FormData.

function formData(formData, filesIgnore = []) {
  let data = new FormData();

  let files = filesIgnore;

  Object.entries(formData).forEach(([key, value]) => {
    if (typeof value === 'object' && !files.includes(key)) {
      data.append(key, JSON.stringify(value) || null);
    } else if (files.includes(key)) {
      data.append(key, value[0] || null);
    } else {
      data.append(key, value || null);
    }
  })

  return data;
}

Как это работает? Он преобразует и вернет все свойства, кроме объектов File, которые вы установили в списке игнорирования (2-й аргумент. Если бы кто-нибудь мог сказать мне, как лучше определить это, это поможет!) В строку json, используяJSON.stringify . Затем на вашем сервере вам просто нужно преобразовать его обратно в объект JSON.

Пример:

let form = {
  first_name: 'John',
  last_name: 'Doe',
  details: {
    phone_number: 1234 5678 910,
    address: '123 Some Street',
  },
  profile_picture: [object FileList] // set by your form file input. Currently only support 1 file per property.
}

function submit() {
  let data = formData(form, ['profile_picture']);

  axios.post('/url', data).then(res => {
    console.log('object uploaded');
  })
}

Я все еще новичок в Http-запросах и JavaScript, поэтому буду очень признателен за любые отзывы!

Gibbu
источник